openrs2
/
openrs2
3
1
Fork 3
Code Issues 73 Pull Requests Releases Activity

Change 'area' to 'build area'
continuous-integration/drone/push Build is passing
Details

Browse Source 
Signed-off-by: Graham <gpe@openrs2.org>
pull/132/head
Graham 3 years ago
parent 832d6ecb6f
commit 1dc2918956
2 changed files with 62 additions and 62 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 16
      share/doc/coordinate-system.md
  2. 108
      share/doc/glossary.md

16
share/doc/coordinate-system.md
Unescape View File

@ -5,7 +5,7 @@
| Name | Levels | Width (tiles) | Height (tiles) | | Name | Levels | Width (tiles) | Height (tiles) |
|------------------------|-------:|--------------:|---------------:| |------------------------|-------:|--------------:|---------------:|
| World | 4 | 16,384 | 16,384 | | World | 4 | 16,384 | 16,384 |
| Area | 1 or 4 | 104 | 104 | | BuildArea | 1 or 4 | 104 | 104 |
| MapSquare | 4 | 64 | 64 | | MapSquare | 4 | 64 | 64 |
| MapSquare (underwater) | 1 | 64 | 64 | | MapSquare (underwater) | 1 | 64 | 64 |
| Viewport (?) | 1 | 32 | 32 | | Viewport (?) | 1 | 32 | 32 |
@ -72,16 +72,16 @@ ground-level areas. 6400 was likely chosen as this corresponds to 100 map
squares, meaning a single "1" digit needs to be added to or removed from the squares, meaning a single "1" digit needs to be added to or removed from the
map's file name to switch between ground level and the corresponding dungeon. map's file name to switch between ground level and the corresponding dungeon.
## Area ## Build area
The area represents the 104x104 group of tiles (or 13x13 group of zones) held in The build area represents the 104x104 group of tiles (or 13x13 group of zones)
the client's memory. Depending on its settings, the client only retains the held in the client's memory. Depending on its settings, the client only retains
player's current level or retains all four levels. the player's current level or retains all four levels.
The area is always zone-aligned. When the area is initially built, it is centred The build area is always zone-aligned. When the area is initially built, it is
around the player's current zone. centred around the player's current zone.
When the player is within 16 tiles of the edge of the current area, it is When the player is within 16 tiles of the edge of the current build area, it is
rebuilt. rebuilt.
## Viewport ## Viewport

108
share/doc/glossary.md
Unescape View File

@ -1,59 +1,59 @@
# 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 |
| Area | | A 104x104 group of tiles (held in memory by the client) | | BAS | Stance | Base animation set |
| BAS | Stance | Base animation set | | 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 | | | Loc | Object | |
| MSI | | Map scenery icon | | MSI | | Map scenery icon |
| MapSquare | Map | A 4x64x64 group of tiles (the granularity of map files in the cache) | | MapSquare | Map | A 4x64x64 group of tiles (the granularity of map files in the cache) |
| Mel | | Map element | | Mel | | Map element |
| Modal | | An interface that can be (manually or automatically) closed by the client | | Modal | | An interface that can be (manually or automatically) closed by the client |
| MultiLoc | | Transforms a loc into another based on a varp or varbit | | MultiLoc | | Transforms a loc into another based on a varp or varbit |
| MultiNPC | | Transforms an NPC into another based on a varp or varbit | | MultiNPC | | Transforms an NPC into another based on a varp or varbit |
| Obj | Item | | | Obj | Item | |
| ObjStack | GroundItem | | | ObjStack | GroundItem | |
| Op | Option, Action | Operation | | Op | Option, Action | Operation |
| Overlay | | An interface that can only be closed by the server | | Overlay | | An interface that can only be closed by the server |
| Packet | Buffer, Stream | | | Packet | Buffer, Stream | |
| Packet.Bit | | Extends the underlying buffer type with ISAAC encryption and bit packing | | Packet.Bit | | Extends the underlying buffer type with ISAAC encryption and bit packing |
| Param | | A key used to add a extra attributes to locs, NPCs, objs and structs | | Param | | A key used to add a extra attributes to locs, NPCs, objs and structs |
| PathingEntity | Character, Entity, Mob | A player or NPC | | PathingEntity | Character, Entity, Mob | A player or NPC |
| ProjAnim | Projectile | | | ProjAnim | Projectile | |
| Region | Instance | | | Region | Instance | |
| ScriptVarType | | An enum representing types that can be used in a client script | | ScriptVarType | | An enum representing types that can be used in a client script |
| Seq | Animation | Sequence | | Seq | Animation | Sequence |
| Skill | Skill | A type of skill | | Skill | Skill | A type of skill |
| Smart | | A data type encoded as a shorter or longer type for bandwidth efficiency | | Smart | | A data type encoded as a shorter or longer type for bandwidth efficiency |
| SpotAnim | Graphic | Spot animation, a combination of a model and a sequence | | SpotAnim | Graphic | Spot animation, a combination of a model and a sequence |
| Stat | | The player's base level, boosted level and experience in a particular skill | | Stat | | The player's base level, boosted level and experience in a particular skill |
| StockMarket | | Grand exchange | | StockMarket | | Grand exchange |
| Struct | | A map of param keys to integer or string values | | Struct | | A map of param keys to integer or string values |
| SubInterface | | An interface attached to a component in a parent interface | | SubInterface | | An interface attached to a component in a parent interface |
| TopLevelInterface | | An interface without a parent | | TopLevelInterface | | An interface without a parent |
| Varbit | ConfigByFile | Player bit variable | | Varbit | ConfigByFile | Player bit variable |
| Varc | | Client variable | | Varc | | Client variable |
| Varcstr | | Client string variable | | Varcstr | | Client string variable |
| Varp | Config | Player variable | | Varp | Config | Player variable |
| Zone | Region, Chunk | A 1x8x8 group of tiles (the granularity used by various packets) | | Zone | Region, Chunk | A 1x8x8 group of tiles (the granularity used by various packets) |
## Loc layers ## Loc layers

Write Preview
Loading…
Cancel
Save