From 59009b9518ca1cef1b1d41f538d27dd2a982054e Mon Sep 17 00:00:00 2001 From: wcko87 Date: Tue, 5 Sep 2017 22:23:59 +0800 Subject: [PATCH] Create entities.md --- docs/events/entities.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/events/entities.md diff --git a/docs/events/entities.md b/docs/events/entities.md new file mode 100644 index 0000000..0f9eb68 --- /dev/null +++ b/docs/events/entities.md @@ -0,0 +1,32 @@ +# Entities + +Entities are generally objects you can interact with in-game. This includes things like: +- Enemies +- Bosses +- Springs / Computer Desks +- NPCs + +## Entity IDs and Types +Each Entity has an Entity ID and a Type. + +For example, a bunny enemy (the first enemy you see in starting forest) has entity ID 1096. +- Entity ID 1096 with Type 0 is a small bunny enemy. +- Entity ID 1096 with Type 5 is a big bunny enemy. (seen near Cocoa1's boss fight) +- Entity ID 1096 with type 6/7 are huge bunny enemies (seen in night forest) + +## Entity Events +The Event ID that spawns an entity is the same as the entity ID itself. Because Entity IDs are in the 1000+ range, they do not conflict with other event types. Thus placing an event with ID 1096 on the map will spawn a small bunny there. + +If you want an entity of type k, place a "type specifier" event above the entity. The type specifier event has an ID of 5000+k. + +For example, to place a Type 5 Bunny on the map, you place an event with ID 1096, and an event with ID 5005 just above it. + +``` ++----+ +|5005| +|----| +|1096| ++----+ +``` + +If no type specifier event is used for the entity, the entity defaults to Type 0.