Skip to main content

Class: DnDRuleset

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

Implements​

Constructors​

new DnDRuleset(roll)​

new DnDRuleset(roll): DnDRuleset

Parameters​

• roll: Roll

Returns​

DnDRuleset

Source​

data/rulesets/dnd-5th.ts:14

Properties​

roll​

roll: Roll

Source​

data/rulesets/dnd-5th.ts:12

Methods​

characterBattleActionOrder()​

characterBattleActionOrder(actor): number

Parameters​

• actor: Actor

Returns​

number

Implementation of​

Ruleset.characterBattleActionOrder

Source​

data/rulesets/dnd-5th.ts:227

characterElementDamageMultiplier()​

characterElementDamageMultiplier(actor, damageType): number

Parameters​

• actor: Actor

• damageType: ElementDefinition

Returns​

number

Implementation of​

Ruleset.characterElementDamageMultiplier

Source​

data/rulesets/dnd-5th.ts:196

characterHit()​

characterHit(attacker, actionDef, defender): boolean

Parameters​

• attacker: Actor

• actionDef: ActionDefinition

• defender: Actor

Returns​

boolean

Implementation of​

Ruleset.characterHit

Source​

data/rulesets/dnd-5th.ts:187

characterHitDamage()​

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

Parameters​

• source: Actor

• action: ActionDefinition

• target: Actor

• effect: CharacterResourceLossEffect

Returns​

number

Implementation of​

Ruleset.characterHitDamage

Source​

data/rulesets/dnd-5th.ts:173

characterIsDead()​

characterIsDead(actor): boolean

Parameters​

• actor: Actor

Returns​

boolean

Implementation of​

Ruleset.characterIsDead

Source​

data/rulesets/dnd-5th.ts:221

characterResistanceAbsolute()​

characterResistanceAbsolute(actor, damageType): number

Parameters​

• actor: Actor

• damageType: ElementDefinition

Returns​

number

Implementation of​

Ruleset.characterResistanceAbsolute

Source​

data/rulesets/dnd-5th.ts:204

characterResistanceMultiplier()​

characterResistanceMultiplier(actor, damageType): number

Parameters​

• actor: Actor

• damageType: ElementDefinition

Returns​

number

Implementation of​

Ruleset.characterResistanceMultiplier

Source​

data/rulesets/dnd-5th.ts:200

characterResourceGeneration()​

characterResourceGeneration(actor): CharacterResourceGeneration[]

Parameters​

• actor: Actor

Returns​

CharacterResourceGeneration[]

Implementation of​

Ruleset.characterResourceGeneration

Source​

data/rulesets/dnd-5th.ts:208

getCharacterEquipmentSlots()​

getCharacterEquipmentSlots(): EquipmentSlotDefinition[]

Returns​

EquipmentSlotDefinition[]

Implementation of​

Ruleset.getCharacterEquipmentSlots

Source​

data/rulesets/dnd-5th.ts:84

getCharacterResourceTypes()​

getCharacterResourceTypes(): CharacterResourceDefinition[]

Returns​

CharacterResourceDefinition[]

Implementation of​

Ruleset.getCharacterResourceTypes

Source​

data/rulesets/dnd-5th.ts:65

getCharacterStatTypes()​

getCharacterStatTypes(): CharacterStatType[]

Returns​

CharacterStatType[]

Implementation of​

Ruleset.getCharacterStatTypes

Source​

data/rulesets/dnd-5th.ts:28

getClassDefinitions()​

getClassDefinitions(): Clazz[]

Returns​

Clazz[]

Implementation of​

Ruleset.getClassDefinitions

Source​

data/rulesets/dnd-5th.ts:109

getCurrentActorTurn()​

getCurrentActorTurn(battle): undefined | Actor

Parameters​

• battle: Battle

Returns​

undefined | Actor

Implementation of​

Ruleset.getCurrentActorTurn

Source​

data/rulesets/dnd-5th.ts:231

getElementDefinitions()​

getElementDefinitions(): ElementDefinition[]

Returns​

ElementDefinition[]

Implementation of​

Ruleset.getElementDefinitions

Source​

data/rulesets/dnd-5th.ts:144

getLevelProgression()​

getLevelProgression(): LevelProgression[]

Returns​

LevelProgression[]

Implementation of​

Ruleset.getLevelProgression

Source​

data/rulesets/dnd-5th.ts:18