Trigger Reference of GS2-Quest Script

Reference of event triggers that call extended scripts

Trigger

startQuest

Quest start

Synchronous Execution Script

Script and Quest start are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
questGroupModel	QuestGroupModel	Quest Group Model
questModel	QuestModel	Quest Model
randomSeed	long	random number seed
rewards	Reward[]	List of rewards earned from quests
userId	string	User ID
config	Config[]	Set values to be applied to transaction variables

Result

	Type	Required	Value Limits	Description
permit	bool	✓		Whether to allow the quest to begin
overrideRandomSeed	long		0 ~ 9223372036854775805	Random number seed
overrideRewards	Reward[]		0 ~ 1000 items	List of rewards earned from quests

Implementation Example

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
randomSeed = args.randomSeed
rewards = args.rewards
userId = args.userId
config = args.config

result = {
  permit=permit,
  overrideRandomSeed=overrideRandomSeed,
  overrideRewards=overrideRewards
}

Asynchronous Execution Script

The script executes asynchronously after the Quest start.

Request

	Type	Description
namespace	Namespace	Namespace
questGroupModel	QuestGroupModel	Quest Group Model
questModel	QuestModel	Quest Model
progress	Progress	Quest Progress
config	Config[]	Set values to be applied to transaction variables

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
progress = args.progress
config = args.config

result = {
}

completeQuest

Quest cleared

Synchronous Execution Script

Script and Quest cleared are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
questGroupModel	QuestGroupModel	Quest Group Model
questModel	QuestModel	Quest Model
rewards	Reward[]	List of rewards obtained from quests
progress	Progress	Quest Progress
config	Config[]	Set values to be applied to transaction variables

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow quests to be cleared
overrideRewards	Reward[]			0 ~ 1000 items	List of rewards earned from quests

Implementation Example

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
progress = args.progress
config = args.config

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

Asynchronous Execution Script

The script executes asynchronously after the Quest cleared.

Request

	Type	Description
namespace	Namespace	Namespace
questGroupModel	QuestGroupModel	Quest Group Model
questModel	QuestModel	Quest Model
rewards	Reward[]	List of rewards obtained from quests
progress	Progress	Quest Progress
config	Config[]	Set values to be applied to transaction variables

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
progress = args.progress
config = args.config

result = {
}

failedQuest

Quest to fail

Synchronous Execution Script

Script and Quest to fail are executed synchronously in that order.

Request

	Type	Description
namespace	Namespace	Namespace
questGroupModel	QuestGroupModel	Quest Group Model
questModel	QuestModel	Quest Model
rewards	Reward[]	List of rewards obtained from quests
config	Config[]	Set values to be applied to transaction variables

Result

	Type	Required	Default	Value Limits	Description
permit	bool	✓			Whether to allow the quest to fail
overrideRewards	Reward[]			0 ~ 1000 items	List of rewards earned from quests

Implementation Example

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
config = args.config

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

Asynchronous Execution Script

The script executes asynchronously after the Quest to fail.

Request

	Type	Description
namespace	Namespace	Namespace
questGroupModel	QuestGroupModel	Quest Group Model
questModel	QuestModel	Quest Model
rewards	Reward[]	List of rewards obtained from quests
config	Config[]	Set values to be applied to transaction variables

Result

	Type	Required	Default	Value Limits	Description

Implementation Example

namespace = args.namespace
questGroupModel = args.questGroupModel
questModel = args.questModel
rewards = args.rewards
config = args.config

result = {
}