ashley
/
reskit
1
0
Fork 0
Code Issues 4 Pull Requests Packages Projects Releases Wiki Activity

Update Design Doc: `level` tool

master
Ashley N. 2023-09-10 16:09:22 +00:00
parent 87598ccce4
commit ff8180f783
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Design-Doc%3A-%60level%60-tool.md

@ -32,7 +32,7 @@ The boolean property `reskit-collision` set on a Tile Layer to `true` indicates
If no layer is defined with `reskit-collision` you will receive a warning on the command line. Generally most maps should include collision data - it is NOT auto-generated! If no layer is defined with `reskit-collision` you will receive a warning on the command line. Generally most maps should include collision data - it is NOT auto-generated!
## Entity-Component System ## Entity-Component System
Reskit assumes a best-practice entity-component engine design and the objects defined in your .tmx file effectively serve as the entities. By adding a property `reskit-component[x]` to each object, where x is the index of the component in an array, you can attach various components to the target object/entity. Each component may have various properties you choose to define, which can be formatted as Tiled property `reskit-component[x].y`, where x is the index of the component and y is the property name for that component. If multiple object layers are defined, reskit will collapse all of them into a single layer. Reskit assumes a best-practice entity-component engine design and the objects defined in your .tmx file effectively serve as the entities. By adding a property `reskit-component[x]` to each object, where x is the name of the component in an array (boolean type), you can attach various components to the target object/entity. Each component may have various properties you choose to define, which can be formatted as Tiled property `reskit-component[x].y`, where x is the name of the component and y is the property name for that component. If multiple object layers are defined, reskit will collapse all of them into a single layer.
By default, reskit will attach one component to each entity: `position`, which is generated from the position set in Tiled Editor. This component has two 16-bit values: x and y position on the map (in pixels, 0,0 is top left of the map). The array index of this component will be one more than the last index listed by the designer. By default, reskit will attach one component to each entity: `position`, which is generated from the position set in Tiled Editor. This component has two 16-bit values: x and y position on the map (in pixels, 0,0 is top left of the map). The array index of this component will be one more than the last index listed by the designer.