Update docs

Author: github-actions[bot]

docs/modules/Cast.md

@@ -0,0 +1,67 @@
+# Cast
+
+## Methods
+
+### `__call`
+
+
+### `new`
+
+Constructor
+
+**Parameters:**
+- `n` integer
+
+
+**Returns:**
+- `Cast` 
+
+### `AsUint8_t`
+
+**Returns:**
+- `uint8_t` 
+
+### `AsInt8_t`
+
+**Returns:**
+- `int8_t` 
+
+### `AsUint16_t`
+
+**Returns:**
+- `uint16_t` 
+
+### `AsInt16_t`
+
+**Returns:**
+- `int16_t` 
+
+### `AsUint32_t`
+
+**Returns:**
+- `uint32_t` 
+
+### `AsInt32_t`
+
+**Returns:**
+- `int32_t` 
+
+### `AsJoaat_t`
+
+**Returns:**
+- `joaat_t` 
+
+### `AsUint64_t`
+
+**[NOTE]** Lua numbers are IEEE-754 doubles so this **will lose precision above 2^53**.
+
+V1 does not have `bigint` or an `FFI` lib so we're stuck with this.
+
+**Returns:**
+- `uint64_t` 
+
+### `AsInt64_t`
+
+**Returns:**
+- `int64_t` 
+

docs/modules/Color.md

@@ -4,7 +4,7 @@
 
 Color instances can be created using color names defined in `Color.string_colors`,
 self-regsitered color names (using the `RegisterNamedColor` method),
-hex strings, ABGR uint_32, RGBA floats (0 - 1), and RGBA numbers (0 - 255).
+hex strings, ABGR uint32, RGBA (0 - 255), and normalized RGBA (0 - 1).
 
 ## Methods
 
@@ -41,14 +41,14 @@ local r, g, b, a = Color("Magenta"):AsRGBA()
 
 ### `AsRGBA`
 
-Returns a color in **RGBA** format.
+Returns a color in **RGBA** format (0 - 255).
 
 **Returns:**
 - `number` , number, number, number
 
 ### `AsFloat`
 
-Returns a color in float format.
+Returns a color in **normalized RGBA** format (0 - 1).
 
 **Returns:**
 - `float` , float, float, float
@@ -62,8 +62,8 @@ Returns a color hex string.
 
 ### `AsU32`
 
-Returns a uint_32 color in **ABGR** format.
+Returns a uint32 color in **ABGR** format.
 
 **Returns:**
-- `number` 
+- `uint32_t` 
 

docs/modules/Entity.md

@@ -18,11 +18,37 @@ Class representing a GTA V entity.
 **Returns:**
 - `Entity` |nil
 
+### `Resolve`
+
+Resolves this entity to its corresponding internal game class (`CEntity`, `CPed`, or `CVehicle`).
+
+If already resolved, returns the cached instance.
+
+> **[Note]**: Inheritance chains are simplified. There is no `fwEntity`, `fwArchetype`, `CPhysical`, etc...
+
+> Instead, the base class is `CEntity` and the others inherit from it.
+
+Usage Example:
+
+```Lua
+print(Self:Resolve().m_max_health:get_float()) -- -> 200.0 (Single Player Michael)
+
+local veh = Self:GetVehicle()
+if veh then
+local cvehicle = veh:Resolve()
+print(cvehicle.m_max_health:get_float()) -- -> 1000.0
+print(cvehicle.m_handling_flags:get_dword()) -- -> integer<uint32_t> (depends on the vehicle)
+end
+```
+
+**Returns:**
+- `T` 
+
 ### `Create`
 
 **Parameters:**
-- `modelHash` Hash
-- `entityType` eEntityTypes
+- `modelHash` hash
+- `entityType` eEntityType
 - `pos?` vec3
 - `heading?` number
 - `isNetwork?` boolean
@@ -38,12 +64,12 @@ Class representing a GTA V entity.
 ### `GetHandle`
 
 **Returns:**
-- `Handle` 
+- `handle` 
 
 ### `GetModelHash`
 
 **Returns:**
-- `Hash` 
+- `joaat_t` 
 
 ### `GetPointer`
 

docs/modules/Game.md

@@ -100,7 +100,7 @@ Native wrappers.
 
 **Parameters:**
 - `entity` integer
-- `entity_type?` eEntityTypes
+- `entity_type?` eEntityType
 
 
 
@@ -415,7 +415,7 @@ Returns the entity localPlayer is aiming at.
 ### `GetEntityModel`
 
 **Parameters:**
-- `entity` integer
+- `entity` handle
 
 
 **Returns:**
@@ -424,16 +424,16 @@ Returns the entity localPlayer is aiming at.
 ### `GetEntityType`
 
 **Parameters:**
-- `entity` integer
+- `entity` handle
 
 
 **Returns:**
-- `integer` 
+- `eEntityType` 
 
 ### `GetEntityTypeString`
 
 **Parameters:**
-- `entity` integer
+- `entity` handle
 
 
 **Returns:**
@@ -442,7 +442,7 @@ Returns the entity localPlayer is aiming at.
 ### `GetModelDimensions`
 
 **Parameters:**
-- `model` integer
+- `model` joaat_t
 
 
 **Returns:**
@@ -455,7 +455,7 @@ Returns a number for the vehicle seat the provided ped
 is sitting in (-1 driver, 0 front passenger, etc...).
 
 **Parameters:**
-- `ped` integer
+- `ped` handle
 
 
 **Returns:**
@@ -674,3 +674,12 @@ Draws a green chevron down element on top of an entity in the game world.
 
 
 
+### `LoadGroundAtCoord`
+
+Loads ground at the given coordinates. **Must be called in a coroutine**.
+
+**Parameters:**
+- `coords` vec3
+
+
+

docs/modules/Memory.md

@@ -17,12 +17,12 @@ Handles most interactions with the game's memory.
 ### `GetGameState`
 
 **Returns:**
-- `number` |nil
+- `byte` 
 
 ### `GetGameTime`
 
 **Returns:**
-- `number` 
+- `uint32_t` 
 
 ### `GetScreenResolution`
 
@@ -56,7 +56,7 @@ Useful if I figure out a way to make strong patterns for script globals
 ### `GetPedInfo`
 
 **Parameters:**
-- `ped` integer A Ped ID, not a Player ID.
+- `ped` handle A Ped ID, not a Player ID.
 
 
 **Returns:**
@@ -67,7 +67,7 @@ Useful if I figure out a way to make strong patterns for script globals
 Checks if a vehicle's handling flag is set.
 
 **Parameters:**
-- `vehicle` integer
+- `vehicle` handle
 - `flag` eVehicleHandlingFlags
 
 
@@ -77,7 +77,7 @@ Checks if a vehicle's handling flag is set.
 ### `GetVehicleModelInfoFlag`
 
 **Parameters:**
-- `vehicle` integer
+- `vehicle` handle
 - `flag` eVehicleModelFlags
 
 
@@ -91,7 +91,7 @@ Unsafe for non-scripted entities.
 Returns the model type of an entity (ped, object, vehicle, MLO, time, etc...)
 
 **Parameters:**
-- `entity` integer
+- `entity` handle
 
 
 **Returns:**

docs/modules/Ped.md

@@ -6,11 +6,6 @@ Class representing a GTA V Ped.
 
 ## Methods
 
-### `ReadMemoryLayout`
-
-**Returns:**
-- `CPed` |nil
-
 ### `IsValid`
 
 **Returns:**
@@ -64,7 +59,7 @@ Class representing a GTA V Ped.
 ### `GetVehicleWeapon`
 
 **Returns:**
-- `Hash` -- weapon hash or 0.
+- `hash` -- weapon hash or 0.
 
 ### `GetRelationshipGroupHash`
 
@@ -117,7 +112,7 @@ Class representing a GTA V Ped.
 ### `WarpIntoVehicle`
 
 **Parameters:**
-- `vehicle_handle` Handle
+- `vehicle_handle` handle
 - `seatIndex?` number
 
 

docs/modules/Player.md

@@ -6,9 +6,25 @@ Class representing a GTA V player (Unfinished).
 
 ## Methods
 
+### `new`
+
+Constructor
+
+**Parameters:**
+- `player_id` integer
+
+
+**Returns:**
+- `Player` 
+
+### `GetGameState`
+
+**Returns:**
+- `eGameState` 
+
 ### `IsPlaying`
 
-Returns whether the player is currently playing by checking their game state.
+Returns whether the player is currently playing.
 
 **Returns:**
 - `boolean`