mdebray/tvl-depot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gs/xanthous): Start documenting raw types

Browse source 
Start documenting the fields of the raw type YAML files and what they
mean, to make it easier to write new raw types.

Change-Id: I9672b757e89f1cc665d7e90078d83cfd87173d7f
Reviewed-on: https://cl.tvl.fyi/c/depot/+/3865
Reviewed-by: grfn <grfn@gws.fyi>
Tested-by: BuildkiteCI
This commit is contained in:
Griffin Smith 2021-11-13 09:47:03 -05:00 committed by grfn
parent 3c33a2c756
commit 98397b8515
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
users/grfn/xanthous/docs/raw-types.org Normal file
View file

@ -0,0 +1,24 @@
#+TITLE: Raw Types (WIP)
* Raw Types
** Item
*** Attributes
| name | type | commentary |
|-----------------+---------------------------+------------------------------------------------------------------|
| name | string | |
| description | string | Not capitalized, should usually start with an indefinite article |
| longDescription | string | Capitalized, should usually start with an indefinite article |
| char | [[*EntityChar][EntityChar]] | |
| wieldable | [[*EntityWieldable][EntityWieldable]] | |
| density | number , [number, number] | Density, or range for random density, in g/m³ |
| volume | number , [number, number] | Volume, or range for random volume, in m³ |
* Data Types
** EntityChar
*** Attributes
| name | type | commentary |
|-------+------+-------------------------------------------------------|
| char | char | How the entity is displayed when dropped on the floor |
| style | Attr | |
** TODO EntityWieldable
** TODO Attr