Default Sheet Settings
From Roll20 Wiki
Revision as of 22:29, 21 July 2019 by Andreas J. (Talk | contribs)
Character Sheets can store settings for all characters in the useroptions section of the sheet.json file. These settings can be updated easily in the Game Settings. An simple example of what can be done with these settings can be found in the Star Trek sheet.json file. More complex examples can be found in the D&D 5e by Roll20 sheet.json file, or the Pathfinder Official sheet.json.
If you search the Roll20 Sheet repository for uses of "useroptions"
you can find further examples of Default option in usage.
Data fields options:
- attribute - the name of the sheet variable set with this option. Don't include the
attr_
prefix in the name. - displayname - Title element of the selection
- displaytranslationkey - i18n translation key for translation into other languages(not mandatory if sheet doesn't use translations)
- type - the HTML input element to be used in Game Settings Page. Options include:
select
,radio
,checkbox
,text
,number
- options - If your input element has predefined options, the key/value pairs are listed here
- optiontranslationkeys - i18n translation keys for the options (not mandatory if sheet doesn't use translations)
- default/value - the default value of the attribute. If used for a select input with multiple options, set this to the value of the wanted default selection, not incuding the key. Use either default or value.
- description - a text string use to give further detail about the option and the changes it controls
- descriptiontranslationkey - i18n translation key used for the description (not mandatory if sheet doesn't use translations)