diff options
| author | Griffin Smith <grfn@gws.fyi> | 2021-11-13T14·47-0500 |
|---|---|---|
| committer | grfn <grfn@gws.fyi> | 2021-11-13T15·57+0000 |
| commit | 98397b8515c83ca2c4caf0a3e9ea3556aac736d7 (patch) | |
| tree | 42ae5a44cff7d06348fc16fe63d92fec5b2a4087 /users | |
| parent | 3c33a2c75659416a7413e9c5a3c18a3397b0fd58 (diff) | |
docs(gs/xanthous): Start documenting raw types r/3058
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
Diffstat (limited to 'users')
| -rw-r--r-- | users/grfn/xanthous/docs/raw-types.org | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/users/grfn/xanthous/docs/raw-types.org b/users/grfn/xanthous/docs/raw-types.org new file mode 100644 index 000000000000..e5bcda04268f --- /dev/null +++ b/users/grfn/xanthous/docs/raw-types.org @@ -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 |