game-data-gen 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +9 -5
  2. package/dist/main.js +14 -2221
  3. package/package.json +6 -7
package/README.md CHANGED
@@ -70,6 +70,8 @@ Supported field types:
70
70
 
71
71
  Supported array field types:
72
72
 
73
+ - string
74
+ - boolean
73
75
  - number
74
76
  - int8
75
77
  - int16
@@ -84,11 +86,13 @@ Supported array field types:
84
86
 
85
87
  The length of the array field.
86
88
 
87
- In case of a Structure of Arrays data structure (type=soa), setting the length on the type is recommended so that all arrays have the same length.
89
+ In case of a Structure of Arrays data structure (type=soa), setting the length on the type instead is recommended so that all arrays have the same length.
88
90
 
89
91
  ## Example
90
92
 
91
- Create a plain text file somewhere in your source code (it does not need a file extension). For example `src/data/game`:
93
+ Create a plain text file somewhere in your source code (without a file extension).
94
+
95
+ For example `src/data/game`:
92
96
 
93
97
  ```
94
98
  Game
@@ -111,7 +115,7 @@ This will create or update the `src/data/game.ts` file:
111
115
  ```typescript
112
116
  /*
113
117
  * --------------------------------------------------
114
- * Game
118
+ * Game (group)
115
119
  * --------------------------------------------------
116
120
  */
117
121
 
@@ -129,7 +133,7 @@ export function zeroGameData() {
129
133
 
130
134
  /*
131
135
  * --------------------------------------------------
132
- * Entity
136
+ * Entity (Structure of Arrays)
133
137
  * --------------------------------------------------
134
138
  */
135
139
 
@@ -167,4 +171,4 @@ export function zeroEntityData() {
167
171
  }
168
172
  ```
169
173
 
170
- Then import the data and its functions from `src/data/game.ts` into your code.
174
+ Then import the data and its functions from `src/data/game.ts` in your code.