From 98397b8515c83ca2c4caf0a3e9ea3556aac736d7 Mon Sep 17 00:00:00 2001 From: Griffin Smith Date: Sat, 13 Nov 2021 09:47:03 -0500 Subject: docs(gs/xanthous): Start documenting raw types 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 Tested-by: BuildkiteCI --- users/grfn/xanthous/docs/raw-types.org | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 users/grfn/xanthous/docs/raw-types.org 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 -- cgit 1.4.1