Add Js5Index and Js5MasterIndex to the glossary

Signed-off-by: Graham <gpe@openrs2.org>
pull/132/head
Graham 3 years ago
parent 1dc2918956
commit 9c3959769f
  1. 110
      share/doc/glossary.md

@ -1,59 +1,61 @@
# Glossary # Glossary
| Jagex name | RSPS community name(s) | Description | | Jagex name | RSPS community name(s) | Description |
|--------------------|------------------------|------------------------------------------------------------------------------| |--------------------|----------------------------|------------------------------------------------------------------------------|
| | V1 | A middle-endian byte order used on [Honeywell Series 16][hs16] computers | | | V1 | A middle-endian byte order used on [Honeywell Series 16][hs16] computers |
| | Viewport | A 1x32x32 group of tiles (inside which other players and NPcs are visible) | | | Viewport | A 1x32x32 group of tiles (inside which other players and NPcs are visible) |
| Alt3 | V2 | A middle-endian byte order used on [PDP-11][pdp11] computers | | Alt3 | V2 | A middle-endian byte order used on [PDP-11][pdp11] computers |
| Ap | | An op that trigers when you approach (rather than reach) the target | | Ap | | An op that trigers when you approach (rather than reach) the target |
| BAS | Stance | Base animation set | | BAS | Stance | Base animation set |
| BuildArea | | A 104x104 group of tiles (held in memory by the client) | | BuildArea | | A 104x104 group of tiles (held in memory by the client) |
| CS1 | | Client script version 1 | | CS1 | | Client script version 1 |
| CS2 | | Client script version 2 | | CS2 | | Client script version 2 |
| Component | | A user interface element (examples include buttons, text boxes, icons, etc.) | | Component | | A user interface element (examples include buttons, text boxes, icons, etc.) |
| CoordFine | | A position more precise than a grid coord (128 units per tile in build 550) | | CoordFine | | A position more precise than a grid coord (128 units per tile in build 550) |
| CoordGrid | Position | The position of a tile | | CoordGrid | Position | The position of a tile |
| Entity | Animable, Renderable | | | Entity | Animable, Renderable | |
| Enum | | A bidirectional map between integer keys and integer or string values | | Enum | | A bidirectional map between integer keys and integer or string values |
| Flo | | Floor overlay | | Flo | | Floor overlay |
| Flu | | Floor underlay | | Flu | | Floor underlay |
| GoSubFrame | StackFrame | | | GoSubFrame | StackFrame | |
| IDK | IdentityKit | Identikit | | IDK | IdentityKit | Identikit |
| Interface | | A group of components | | Interface | | A group of components |
| Inv | Inventory | | | Inv | Inventory | |
| JS5 | | Jagex store version 5? | | JS5 | | Jagex store version 5? |
| Loc | Object | | | Js5Index | ReferenceTable | |
| MSI | | Map scenery icon | | Js5MasterIndex | ChecksumTable, update keys | |
| MapSquare | Map | A 4x64x64 group of tiles (the granularity of map files in the cache) | | Loc | Object | |
| Mel | | Map element | | MSI | | Map scenery icon |
| Modal | | An interface that can be (manually or automatically) closed by the client | | MapSquare | Map | A 4x64x64 group of tiles (the granularity of map files in the cache) |
| MultiLoc | | Transforms a loc into another based on a varp or varbit | | Mel | | Map element |
| MultiNPC | | Transforms an NPC into another based on a varp or varbit | | Modal | | An interface that can be (manually or automatically) closed by the client |
| Obj | Item | | | MultiLoc | | Transforms a loc into another based on a varp or varbit |
| ObjStack | GroundItem | | | MultiNPC | | Transforms an NPC into another based on a varp or varbit |
| Op | Option, Action | Operation | | Obj | Item | |
| Overlay | | An interface that can only be closed by the server | | ObjStack | GroundItem | |
| Packet | Buffer, Stream | | | Op | Option, Action | Operation |
| Packet.Bit | | Extends the underlying buffer type with ISAAC encryption and bit packing | | Overlay | | An interface that can only be closed by the server |
| Param | | A key used to add a extra attributes to locs, NPCs, objs and structs | | Packet | Buffer, Stream | |
| PathingEntity | Character, Entity, Mob | A player or NPC | | Packet.Bit | | Extends the underlying buffer type with ISAAC encryption and bit packing |
| ProjAnim | Projectile | | | Param | | A key used to add a extra attributes to locs, NPCs, objs and structs |
| Region | Instance | | | PathingEntity | Character, Entity, Mob | A player or NPC |
| ScriptVarType | | An enum representing types that can be used in a client script | | ProjAnim | Projectile | |
| Seq | Animation | Sequence | | Region | Instance | |
| Skill | Skill | A type of skill | | ScriptVarType | | An enum representing types that can be used in a client script |
| Smart | | A data type encoded as a shorter or longer type for bandwidth efficiency | | Seq | Animation | Sequence |
| SpotAnim | Graphic | Spot animation, a combination of a model and a sequence | | Skill | Skill | A type of skill |
| Stat | | The player's base level, boosted level and experience in a particular skill | | Smart | | A data type encoded as a shorter or longer type for bandwidth efficiency |
| StockMarket | | Grand exchange | | SpotAnim | Graphic | Spot animation, a combination of a model and a sequence |
| Struct | | A map of param keys to integer or string values | | Stat | | The player's base level, boosted level and experience in a particular skill |
| SubInterface | | An interface attached to a component in a parent interface | | StockMarket | | Grand exchange |
| TopLevelInterface | | An interface without a parent | | Struct | | A map of param keys to integer or string values |
| Varbit | ConfigByFile | Player bit variable | | SubInterface | | An interface attached to a component in a parent interface |
| Varc | | Client variable | | TopLevelInterface | | An interface without a parent |
| Varcstr | | Client string variable | | Varbit | ConfigByFile | Player bit variable |
| Varp | Config | Player variable | | Varc | | Client variable |
| Zone | Region, Chunk | A 1x8x8 group of tiles (the granularity used by various packets) | | Varcstr | | Client string variable |
| Varp | Config | Player variable |
| Zone | Region, Chunk | A 1x8x8 group of tiles (the granularity used by various packets) |
## Loc layers ## Loc layers

Loading…
Cancel
Save