uberwald/l5rx-chiaroscuro
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

added pre version of a wiki

Browse Source
This commit is contained in:
Vlyan
2022-07-27 18:16:42 +02:00
parent 66cb3d08ad
commit ba5f27674d
14 changed files with 331 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
wiki/dev/dicepicker.md Normal file
View File

@@ -0,0 +1,37 @@
# DicePicker (DP)
The DicePicker is the entry point to any L5R roll (but chat command).
## Usage exemple
```js
new game.l5r5e.DicePickerDialog({
skillId: 'aesthetics',
ringId: 'water',
actor: game.user.character
}).render(true);
```
## Constructor Options
| Property | Type | Notes / Exemples |
|------------------|----------|-------------------------------------------------------------------------------------------------------------------------------|
| actor | Actor | Any `Actor` object instance.<br>ex : `game.user.character`, `canvas.tokens.controlled[0].actor` |
| actorId | string | This is the `id` not the `uuid` of an actor.<br>ex : "AbYgKrNwWeAxa9jT" |
| actorName | string | Careful this is case sensitive.<br>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 |
| itemUuid | string | The `uuid` of technique or weapon used for this roll. Can be anything retrieved by `fromUuid()` or `fromUuidSync()` |
| ringId | string | If not provided, take the current stance of the actor if any.<br>ex : "fire", "water" |
| skillId | string | Skill `id`<br>ex : "design", "aesthetics", "courtesy" |
| skillCatId | string | Skill category `id`<br>ex : "artisan", "scholar" |
| skillsList | string[] | `skillId`/`skillCatId` list coma separated.<br>Allow the player to select the skill used in a select<br>ex : "artisan,design" |
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