Files
l5rx-chiaroscuro/wiki/dev/dicepicker.md
2022-07-29 12:32:38 +02:00

3.2 KiB

DicePicker (DP)

The DicePicker is the entry point to any L5R roll (but chat command).

Usage example

new game.l5r5e.DicePickerDialog({
    skillId: 'aesthetics',
    ringId: 'water',
    actor: game.user.character
}).render(true);

Constructor Options

Property Type Notes / Examples
actor Actor Any Actor object instance.
ex : game.user.character, canvas.tokens.controlled[0].actor
actorId string This is the id not the uuid of an actor.
ex : "AbYgKrNwWeAxa9jT"
actorName string Careful this is case-sensitive.
ex : "Isawa Aki"
difficulty number 1 to 9
difficultyHidden boolean If true, hide the difficulty and lock the view for the player.
isInitiativeRoll boolean true if this is an initiative roll.
item Item The object of technique or weapon used for this roll.
Added in v1.9.0
itemUuid string The uuid of technique or weapon used for this roll. Can be anything retrieved by fromUuid() or fromUuidSync()
Added in v1.9.0
ringId string If not provided, take the current stance of the actor if any.
ex : "fire", "water"
skillId string Skill id
ex : "design", "aesthetics", "courtesy"
skillCatId string Skill category id
ex : "artisan", "scholar"
skillsList string[] skillId/skillCatId list coma separated.
Allow the player to select the skill used in a select
ex : "artisan,design"
target TokenDocument The targeted Token
Added in v1.9.0

All these properties are optional.

For actor* properties, the resolution is in this order :

  1. option.actor
  2. option.actorId
  3. option.actorName
  4. Try to find the first controlled token by the player (canvas.tokens.controlled[0]?.actor)
  5. Use the assigned character if any (game.user.character)
  6. If nothing found, then no actor are set