Documentation Github Stefouch

Global

Members

# constant YZUR

All constants used by YZUR which are stored in Foundry's CONFIG.YZUR.

Properties:
Name Type Attributes Default Description
game string

The identifier for the game
Chat Object

Options for the chat
showInfos boolean <optional>
 true

Whether to show the additional information under the roll result
diceSorting Array.<DieTypeString> <optional>
 ['base', 'skill', 'neg', 'gear', 'arto', 'loc', 'ammo']

Defines the default order
Roll Object

Options for the YearZeroRoll class
chatTemplate string

Path to the chat template
tooltipTemplate string

Path to the tooltip template
infosTemplate string

Path to the infos template
Dice Object

Options for the YearZeroDie class
localizeDieTypes boolean <optional>
 true

Whether to localize the type of the die
DIE_TYPES Array.<DieTypeString>

An array of YearZeroDie types
DIE_TERMS Object.<DieTermString, class>

An enumeration of YearZeroDie classes
Icons Object

Options for the icons and what's on the die faces
getLabel function <optional>
 getLabel( type: DieTypeString, result: number )

A customizable helper function for creating the labels of the die. Note: You must return a string or DsN will throw an error.
yzGame Object.<DieTypeString, Object.<string, (string|number)>>

Defines the labels for your dice. Change yzGame with the game identifier

View Source yzur.js, line 700

Type Definitions

Object

# DieClassData

An object that is used to build a new class that extends the YearZeroDie class.

Properties:
Name Type Attributes Description
name string

The name of the new Die class
denomination DieDeno

The denomination of the new Die class
faces faces

The number of faces of the new Die class
type DieTypeString <optional>

The type of the new Die class
lockedValues Array.<number> <optional>

An array of values that disallow the die to be pushed

View Source yzur.js, line 987

string

# DieDeno

Defines a YZ die's denomination.

View Source yzur.js, line 982

string

# DieTermString

Defines a term of a YZ die. It's a shortcut to its class.

  • base: Base Die (locked on 1 and 6, trauma on 1)
  • skill: Skill Die (locked on 6)
  • gear: Gear Die (locked on 1 and 6, gear damage on 1)
  • neg: Negative Die (locked on 6, negative success)
  • stress: Stress Die (locked on 1 and 6, stress, panic)
  • artoD8: D8 Artifact Die (locked on 6+, multiple successes)
  • artoD10: D10 Artifact Die (locked on 6+, multiple successes)
  • artoD12: D12 Artifact Die (locked on 6+, multiple successes)
  • a: Twilight 2000's D12 Die (locked on 1 and 6+, multiple successes)
  • b: Twilight 2000's D10 Die (locked on 1 and 6+, multiple successes)
  • c: Twilight 2000's D8 Die (locked on 1 and 6+)
  • d: Twilight 2000's D6 Die (locked on 1 and 6+)
  • ammo: Twilight 2000's Ammo Die (locked on 1 and 6, not success but hit)
  • loc: Twilight 2000's Location Die
  • brD12: Blade Runner's D12 Die (locked on 1 and 10+)
  • brD10: Blade Runner's D10 Die (locked on 1 and 10)
  • brD8: Blade Runner's D8 Die (locked on 1 and 6+)
  • brD6: Blade Runner's D6 Die (locked on 1 and 6)

View Source yzur.js, line 946

string

# DieTypeString

Defines a type of a YZ die, its generic role and function.

  • base: Base Die
  • skill: Skill Die
  • gear: Gear Die
  • neg: Negative Die
  • stress: Stress Die
  • arto: Artifact Die
  • ammo: Ammo Die
  • loc: Location Die

View Source yzur.js, line 969

string

# GameTypeString

Defines a Year Zero game.

  • myz: Mutant Year Zero
  • fbl: Forbidden Lands
  • alien: Alien RPG
  • cor: Coriolis The Third Horizon
  • tales: Tales From the Loop & Things From the Flood
  • vae: Vaesen
  • t2k: Twilight 2000
  • br: Blade Runner RPG

View Source yzur.js, line 933

Object

# TermBlok

An object that is used to define a YearZero DieTerm.

Properties:
Name Type Attributes Description
term DieDeno

The denomination of the dice to create
number number

The quantity of those dice
flavor string <optional>

(optional) Any flavor tied to those dice
maxPush number <optional>

(optional) Special maxPush modifier but only for the those dice

View Source yzur.js, line 997

Object

# YearZeroDieTermResult

Result of a rolled YearZero DieTerm.

Properties:
Name Type Description
result number

The numeric result
active boolean

Is this result active, contributing to the total?
count number

A value that the result counts as, otherwise the result is not used directly as
success boolean

Does this result denote a success?
failure boolean

Does this result denote a failure?
discarded boolean

Was this result discarded?
rerolled boolean

Was this result rerolled?
exploded boolean

Was this result exploded?
pushed boolean

✨ Was this result pushed?
hidden boolean

✨ Hides the die for DsN
indexResult number

✨ Index of the result, and column position in the chat tooltip
indexPush number

✨ Index of the push, and row position in the chat tooltip
See:
  • ✨ Extra features added by the override.
  • (FoundryVTT) DieTermResult

View Source yzur.js, line 1006