monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: item/location name must not be numeric

This commit is contained in:
black-sliver 2022-09-20 08:08:43 +02:00
parent a95d0ce9ef
commit 2d5ec6ce22
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/world api.md
View File

@ -103,8 +103,9 @@ or boss drops for RPG-like games but could also be progress in a research tree.
Each location has a `name` and an `id` (a.k.a. "code" or "address"), is placed Each location has a `name` and an `id` (a.k.a. "code" or "address"), is placed
in a Region and has access rules. in a Region and has access rules.
The name needs to be unique in each game, the ID needs to be unique across all The name needs to be unique in each game and must not be numeric (has to
games and is best in the same range as the item IDs. contain least 1 letter or symbol). The ID needs to be unique across all games
and is best in the same range as the item IDs.
World-specific IDs are 1 to 2<sup>53</sup>-1, IDs ≤ 0 are global and reserved. World-specific IDs are 1 to 2<sup>53</sup>-1, IDs ≤ 0 are global and reserved.
Special locations with ID `None` can hold events. Special locations with ID `None` can hold events.
@ -121,6 +122,9 @@ their world. Progression items will be assigned to locations with higher
priority and moved around to meet defined rules and accomplish progression priority and moved around to meet defined rules and accomplish progression
balancing. balancing.
The name needs to be unique in each game, meaning a duplicate item has the
same ID. Name must not be numeric (has to contain at least 1 letter or symbol).
Special items with ID `None` can mark events (read below). Special items with ID `None` can mark events (read below).
Other classifications include Other classifications include