Skip to content

Class SkillUseOptions⚓︎

A table of parameters for when a skill is used. Must contain one of skillGain or useType.

It's best to always include useType if applicable, even if you set skillGain, as it may be used by handlers to make decisions.


SkillUseOptions.skillGain the numeric amount of skill to be gained
SkillUseOptions.useType an index into the skill's SkillProps.skillGain table; must first be set there to have an effect
SkillUseOptions.scale a multiplier to apply to the skill gain; ignored if skillGain is set

Fields⚓︎


SkillUseOptions.skillGain⚓︎

the numeric amount of skill to be gained

SkillUseOptions.skillGain : number?

SkillUseOptions.useType⚓︎

an index into the skill's SkillProps.skillGain table; must first be set there to have an effect

SkillUseOptions.useType : any

SkillUseOptions.scale⚓︎

a multiplier to apply to the skill gain; ignored if skillGain is set

SkillUseOptions.scale : number?