Trigger Reference of GS2-Experience Script

Reference for event triggers that call extended scripts, as defined in GS2-Experience

rankCapScript

Event trigger to call GS2-Script when obtaining rank caps.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
userId	string	User Id
propertyId	string	Property ID

Result

	Type	Require	Default	Limitation	Description
rankCap	long	✓		~ 2147483645	rank cap

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
userId = args.userId
propertyId = args.propertyId

result = {
  rankCap=rankCap
}

changeExperience

Event trigger to call GS2-Script before experience changes.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status before change
afterStatus	Status	Status after change

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow experience change
overrideExperienceValue	long	✓		~ 2147483645	Amount of experience change

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
afterStatus = args.afterStatus

result = {
  permit=permit,
  overrideExperienceValue=overrideExperienceValue
}

changeExperienceDone

GS2-Script called after experience changes.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status

result = {
}

changeRank

Event trigger to call GS2-Script before rank changes.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status before change
afterStatus	Status	Status after change

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow experience change

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
afterStatus = args.afterStatus

result = {
  permit=permit
}

changeRankDone

GS2-Script called after rank changes.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status

result = {
}

changeRankCap

Event trigger to call GS2-Script before rank cap changes.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status before change
afterStatus	Status	Status after change

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow rank cap change
overrideRankCapValue	long	✓		~ 2147483645	New rank cap

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
afterStatus = args.afterStatus

result = {
  permit=permit,
  overrideRankCapValue=overrideRankCapValue
}

changeRankCapDone

GS2-Script called after rank cap changes.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status

Result

	Type	Require	Default	Limitation	Description

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status

result = {
}

overflowExperience

Event trigger to call GS2-Script when experience overflow occurs.

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
status	Status	Status
overflowExperienceValue	long	Experience overflow value

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow experience overflow

Implementation Example

namespace = args.namespace
experienceModel = args.experienceModel
status = args.status
overflowExperienceValue = args.overflowExperienceValue

result = {
  permit=permit
}