NAV
GS2-Script

GS2-Quest

Reference for event triggers that call GS2-Script

GS2-Script Reference

Trigger

startQuest

startQuest

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

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

Event trigger to call GS2-Script before the quest begins.

Request

Type Description
namespace Namespace Namespace
questGroupModel QuestGroupModel Quest Group Model
questModel QuestModel Quest Model
randomSeed long random number seed
rewards Reward[] Maximum rewards earned from quests
config Config[] Set values to be applied to stamp sheet variables

Result

Type Require Default Limitation Description
permit bool Allow the quest to begin
overrideRandomSeed long ~ 9223372036854775806 Random number seed
overrideRewards Reward[] [] Maximum rewards earned from quests

startQuestDone

startQuestDone

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

result = {
}

GS2-Script called after the quest begins.

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 stamp sheet variables

Result

Type Require Default Limitation Description

completeQuest

completeQuest

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

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

Event trigger to call GS2-Script before the quest is cleared.

Request

Type Description
namespace Namespace Namespace
questGroupModel QuestGroupModel Quest Group Model
questModel QuestModel Quest Model
rewards Reward[] Rewards earned from quests
progress Progress Quest Progress
config Config[] Set values to be applied to stamp sheet variables

Result

Type Require Default Limitation Description
permit bool Allow quests to be cleared
overrideRewards Reward[] [] Maximum rewards earned from quests

completeQuestDone

completeQuestDone

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

result = {
}

GS2-Script called after the quest is cleared.

Request

Type Description
namespace Namespace Namespace
questGroupModel QuestGroupModel Quest Group Model
questModel QuestModel Quest Model
rewards Reward[] Rewards earned from quests
progress Progress Quest Progress
config Config[] Set values to be applied to stamp sheet variables

Result

Type Require Default Limitation Description

failedQuest

failedQuest

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

result = {
  permit=permit,
  overrideRewards=overrideRewards
}

Event trigger to call GS2-Script before the quest fails.

Request

Type Description
namespace Namespace Namespace
questGroupModel QuestGroupModel Quest Group Model
questModel QuestModel Quest Model
rewards Reward[] Rewards earned from quests
config Config[] Set values to be applied to stamp sheet variables

Result

Type Require Default Limitation Description
permit bool Allow quests to fail
overrideRewards Reward[] [] Maximum rewards earned from quests

failedQuestDone

failedQuestDone

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

result = {
}

GS2-Script called after the quest fails.

Request

Type Description
namespace Namespace Namespace
questGroupModel QuestGroupModel Quest Group Model
questModel QuestModel Quest Model
rewards Reward[] Rewards earned from quests
config Config[] Set values to be applied to stamp sheet variables

Result

Type Require Default Limitation Description