GS2-Experience

Reference for event triggers that call GS2-Script

GS2-Script Reference

Trigger

rankCapScript

rankCapScript

namespace = args.namespace
experienceModel = args.experienceModel
statuses = args.statuses

result = {
  rankCap=rankCap
}

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

Request

	Type	Description
namespace	Namespace	Namespace
experienceModel	ExperienceModel	Experience Model
statuses	Status[]	List of Status

Result

	Type	Require	Default	Limitation	Description
rankCap	int	✓		~ 2147483646	rank cap

changeExperience

changeExperience

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

result = {
  permit=permit,
  overrideExperienceValue=overrideExperienceValue
}

Event trigger to call GS2-Script before experience changes.

Request

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

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow experience change
overrideExperienceValue	int	✓		~ 2147483646	Amount of experience change

changeExperienceDone

changeExperienceDone

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

result = {
}

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

changeRank

changeRank

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

result = {
}

Event trigger to call GS2-Script when rank changes.

Request

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

Result

	Type	Require	Default	Limitation	Description

changeRankCap

changeRankCap

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

result = {
  permit=permit,
  overrideRankCapValue=overrideRankCapValue
}

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

Request

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

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow rank cap change
overrideRankCapValue	int	✓		~ 2147483646	New rank cap

changeRankCapDone

changeRankCapDone

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

result = {
}

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

overflowExperience

overflowExperience

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

result = {
  permit=permit
}

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

Request

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

Result

	Type	Require	Default	Limitation	Description
permit	bool	✓			Allow experience overflow