Skip to content

Commit 698ecec

Browse files
committed
Updated documentation
1 parent 42878e7 commit 698ecec

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,44 @@ Format Example:
122122

123123
#Add all entries with the namespace "minecraft" that are taller than 1 block
124124
+ all(namespace=="minecraft",height>1)
125+
126+
# Sort
127+
The "all" function has an option to sort your entries either alphabetically or by a certain value instead of in the order it is seen. To use it, use the argument "sort=alphabetical" or "sort={key}". The first will sort alphabetically by name, while the second will sort based on the value of the key of each entry. Entries that are not found in the file are sorted alphabetically before entries that are, and entries that have integer values are sorted before entries with string values (which are sorted alphabetically by value).
128+
129+
Alternatively, you can sort an entire tag using the "sort" function that does not require a "+" or "-" at the beginning of the line. The syntax is either "sort(alphabetical)" or "sort(key)".
130+
131+
Format Example:
132+
133+
+ all(sort=height) #Add all sorted by height
134+
sort(alphabetical) #Sort the entire tag alphabetically
135+
136+
# Limit Count
137+
You may limit the number of entries a function receives using either the "limit" argument or (to limit the entire tag) the "limit" function. The syntax for the argument is "limit={number}" and the function is "limit({number})". The number should be an integer. This will splice the list so that only the first {number} entries are included (so "limit=5" will only include the first 5 entries). If there are not that many entries, all entries will be included.
138+
139+
Format Example:
140+
141+
+ all(sort=height,limit=5) #The 5 entities with the lowest height
142+
limit(5) #Limit the length of this tag to 5
143+
144+
# Reverse List
145+
You may specify to perform operations on the entries in reverse order or reverse the order of the entire tag. This is particularly useful for sorting things greatest to least rather than least to greatest. You may use the argument syntax "reverse={true or false}" or the function syntax "reverse".
146+
147+
Format Example:
148+
149+
+ all(sort=height,reverse=true) #All entries from tallest to shortest
150+
reverse #Reverse the order of the entire tag
151+
# Entity Data
152+
The following information is stored for every entity in the ".saved/data/entity_types.csv" file:
153+
|key|description|possible values|
154+
|--|--|--|
155+
|namespace|The namespace the entity is defined in|string, no spaces or ":"
156+
|name|The name of the entry|string, no spaces
157+
|category|The entity category this entity fits in.<br>Hostile entities attack targets on sight.<br>Passive entities do not attack.<br>Neutral entities attack under certain conditions.<br>Projectile entities are fired for attacking.<br>Utility entities are used as tools rather than living creatures.|neutral, hostile, passive, utility, or projectile
158+
|subcategory|A subcategory for the entity (if any)<br>Arthropods are insects that are affected by the "bane of arthropods" enchantment.<br>Undead entities burn in daylight and are harmed by healing potions.<br>Illagers are used in raid events.|n/a, arthropod, undead, or illager
159+
|width|The witdth of the entities hitbox in blocks|decimal number
160+
|height|The height of the entities hitbox in blocks|decimal number
161+
|length|The height of the entities hitbox in blocks (for most entities this is eqwual to the width)|decimal number
162+
|volume|The total amount of space in blocks the entity takes up. Calculated using the formula "length*width*height"|decimal number
163+
|health|The maximum amount of health points this entity can have. "n/a" for entities that do not have health.|n/a or integer
164+
|environment|The prefered environment for this entity|land, air, or water
165+
|dimension|The dimension(s) this entity may be found naturally.|all, none, overworld, nether, end, or overworld/nether

0 commit comments

Comments
 (0)