Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface State

The data class for state.

Hierarchy

Index

Properties

autoRemovalTiming

autoRemovalTiming: number

The timing of automatic state removal.

0: None 1: At end of action 2: At end of turn

chanceByDamage

chanceByDamage: number

Chance of state being removed by damage (%).

Optional description

description: string

iconIndex

iconIndex: number

The icon number.

id

id: number

The ID.

maxTurns

maxTurns: number

The maximum turns of the duration.

message1

message1: string

The message when an actor fell in the state.

message2

message2: string

The message when an enemy fell in the state.

message3

message3: string

The message when the state remains.

message4

message4: string

The message when the state is removed.

meta

meta: object

The Meta.

Type declaration

  • [key: string]: any

minTurns

minTurns: number

The minimum turns of the duration.

motion

motion: number

The side-view motion.

name

name: string

The name.

note

note: string

The text of the note.

overlay

overlay: number

The side-view overlay.

priority

priority: number

The state priority (0..100).

Optional releaseByDamage

releaseByDamage: boolean

removeAtBattleEnd

removeAtBattleEnd: boolean

Removes state at end of battle (true/false).

removeByDamage

removeByDamage: boolean

Removes state by damage (true/false).

removeByRestriction

removeByRestriction: boolean

Removes state by action restriction (true/false).

removeByWalking

removeByWalking: boolean

Removes state by walking (true/false).

restriction

restriction: number

Action restrictions.

0: None 1: Attack enemy 2: Attack enemy or ally 3: Attack ally 4: Cannot act

stepToRemove

stepToRemove: number

Number of steps until state is removed.

traits

traits: Array<Trait>

The array of Trait data.

Generated using TypeDoc