Class SkillProps

A table of properties for a custom skill.

@deprecated use modIntegration.statsWindow instead

---

SkillProps.name	localized name of the skill
SkillProps.description	localized description of the skill (default: nil)
SkillProps.icon	icon information for the skill (default: default icon based on specialization)
SkillProps.attribute	the id of the skill's governing attribute (default: nil)
SkillProps.specialization	the skill's specialization (default: nil)
SkillProps.skillGain	a table mapping SkillUseOptions.useType keys to XP gain amounts (default: empty table)
SkillProps.startLevel	the starting level for this skill (default: 5)
SkillProps.maxLevel	the maximum level for this skill (default: 100; if < 0, no max)
SkillProps.modIntegration	properties for compatibility with other mods
SkillProps.statsWindowProps	properties for Stats Window Extender integration
SkillProps.xpCurve

---

Methods

---

SkillProps.xpCurve

function SkillProps.xpCurve(currentLevel: number)-> number

---

Fields

---

SkillProps.name

localized name of the skill

SkillProps.name : string

---

SkillProps.description

localized description of the skill (default: nil)

SkillProps.description : string?

---

SkillProps.icon

icon information for the skill (default: default icon based on specialization)

SkillProps.icon : { bgr: string, bgrColor: Color, fgr: string, fgrColor: Color }

---

SkillProps.attribute

the id of the skill's governing attribute (default: nil)

SkillProps.attribute : string?

---

SkillProps.specialization

the skill's specialization (default: nil)

SkillProps.specialization : Specialization?

---

SkillProps.skillGain

a table mapping SkillUseOptions.useType keys to XP gain amounts (default: empty table)

SkillProps.skillGain : table<any,number>

---

SkillProps.startLevel

the starting level for this skill (default: 5)

SkillProps.startLevel : number

---

SkillProps.maxLevel

the maximum level for this skill (default: 100; if < 0, no max)

SkillProps.maxLevel : number

---

SkillProps.modIntegration

properties for compatibility with other mods

SkillProps.modIntegration : SkillIntegrationProps {
    statsWindow: SkillStatsWindowProps,
}

---

SkillProps.statsWindowProps

properties for Stats Window Extender integration

SkillProps.statsWindowProps : SkillStatsWindowProps {
    subsection: (StatsWindowSubsection|string)?,
    shortenedName: string?,
    visible: (boolean|fun() -> boolean),
    onClick: (function)?,
}

---