Skip to main content

Interface: Ruleset

A ruleset should implement rules from a table top game system.

  • Level progression definition (how much xp per level, what is unlocked at each level)
  • Stat types (str, dex, con, int, wis, cha -- what does what?)
  • Professions (classes)
  • Character resources (health, mana, movement, etc)
  • Equipment / inventory slots (main hand, off hand, head, chest, etc)
  • Effects (what happens when a character gets hit, what happens when a character hits)
  • Elements (fire, water, earth, air, psychic, physical, etc)
  • Battle rules, who acts first, what determines a hit or a dodge on attack

Methods​

characterBattleActionOrder()​

characterBattleActionOrder(actor): number

Parameters​

• actor: Actor

Returns​

number

Source​

core/ruleset/ruleset.ts:80

characterElementDamageMultiplier()​

characterElementDamageMultiplier(actor, damageType): number

Parameters​

• actor: Actor

• damageType: ElementDefinition

Returns​

number

Source​

core/ruleset/ruleset.ts:91

characterHit()​

characterHit(attacker, action, defender): boolean

Parameters​

• attacker: Actor

• action: ActionDefinition

• defender: Actor

Returns​

boolean

Source​

core/ruleset/ruleset.ts:81

characterHitDamage()​

characterHitDamage(source, action, target, effect): number

Parameters​

• source: Actor

• action: ActionDefinition

• target: Actor

• effect: CharacterResourceLossEffect

Returns​

number

Source​

core/ruleset/ruleset.ts:82

characterIsDead()​

characterIsDead(actor): boolean

Parameters​

• actor: Actor

Returns​

boolean

Source​

core/ruleset/ruleset.ts:92

characterResistanceAbsolute()​

characterResistanceAbsolute(actor, damageType): number

Parameters​

• actor: Actor

• damageType: ElementDefinition

Returns​

number

Source​

core/ruleset/ruleset.ts:89

characterResistanceMultiplier()​

characterResistanceMultiplier(actor, damageType): number

Parameters​

• actor: Actor

• damageType: ElementDefinition

Returns​

number

Source​

core/ruleset/ruleset.ts:88

characterResourceGeneration()​

characterResourceGeneration(actor): CharacterResourceGeneration[]

Parameters​

• actor: Actor

Returns​

CharacterResourceGeneration[]

Source​

core/ruleset/ruleset.ts:90

getCharacterEquipmentSlots()​

getCharacterEquipmentSlots(): EquipmentSlotDefinition[]

Returns​

EquipmentSlotDefinition[]

Source​

core/ruleset/ruleset.ts:75

getCharacterResourceTypes()​

getCharacterResourceTypes(): CharacterResourceDefinition[]

Returns​

CharacterResourceDefinition[]

Source​

core/ruleset/ruleset.ts:74

getCharacterStatTypes()​

getCharacterStatTypes(): CharacterStatType[]

Returns​

CharacterStatType[]

Source​

core/ruleset/ruleset.ts:73

getClassDefinitions()​

getClassDefinitions(): Clazz[]

Returns​

Clazz[]

Source​

core/ruleset/ruleset.ts:76

getCurrentActorTurn()​

getCurrentActorTurn(battle): undefined | Actor

Parameters​

• battle: Battle

Returns​

undefined | Actor

Source​

core/ruleset/ruleset.ts:78

getElementDefinitions()​

getElementDefinitions(): ElementDefinition[]

Returns​

ElementDefinition[]

Source​

core/ruleset/ruleset.ts:77

getLevelProgression()​

getLevelProgression(): LevelProgression[]

Returns​

LevelProgression[]

Source​

core/ruleset/ruleset.ts:72