feat(natives/interior): update interiors natives/examples

* Update PIN_INTERIOR_IN_MEMORY * Update IS_INTERIOR_ENTITY_SET_ACTIVE * Update ENABLE_SHADOW_CULL_MODEL_THIS_FRAME * Update ENABLE_EXTERIOR_CULL_MODEL_THIS_FRAME * Update DISABLE_METRO_SYSTEM * Update DEACTIVATE_INTERIOR_ENTITY_SET * Update ACTIVATE_INTERIOR_ENTITY_SET refactor(example): set the player into the interior * In the example of PinMemory when the interior is ready we are now teleporting the player in the interior * Removed the gtaforum link Co-Authored-By: Dillon Skaggs <[email protected]>
citizenfx · Aug 6, 2024 · 7754843 · 7754843
1 parent 5999728
commit 7754843
Show file tree

Hide file tree

Showing 9 changed files with 264 additions and 41 deletions.
diff --git a/INTERIOR/ActivateInteriorEntitySet.md b/INTERIOR/ActivateInteriorEntitySet.md
@@ -9,11 +9,52 @@ aliases: ["0x55E86AF2712B36A1","_ENABLE_INTERIOR_PROP"]
 void ACTIVATE_INTERIOR_ENTITY_SET(int interior, char* entitySetName);
 ```
 
+Activates the entity set with the specified name in the given interior. If you want to disable a entity set, use [`DEACTIVATE_INTERIOR_ENTITY_SET`](#_0x420BD37289EEE162).
+
 ```
-More info: http://gtaforums.com/topic/836367-adding-props-to-interiors/  
+NativeDB Introduced: v323
 ```
 
 ## Parameters
-* **interior**: 
-* **entitySetName**: 
+* **interior**: The index of the interior.
+* **entitySetName**: The name of the entity set to activate.
+
+## Examples
+```lua
+-- Get the interior id for the casino penthouse
+local interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641)
+
+-- Activate certain entity sets for the casino penthouse
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Spa_Bar_Open')
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Media_Bar_Open')
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Arcade_Retro')
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Bar_Clutter')
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Clutter_03')
+ActivateInteriorEntitySet(interiorID, 'Set_pent_bar_light_02')
+```
+```javascript
+// Get the interior id for the casino penthouse
+const interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641);
+
+// Activate certain entity sets for the casino penthouse
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Spa_Bar_Open');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Media_Bar_Open');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Arcade_Retro');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Bar_Clutter');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Clutter_03');
+ActivateInteriorEntitySet(interiorID, 'Set_pent_bar_light_02');
+```
+```csharp
+using static CitizenFX.Core.Native.API;
+
+// Get the interior id for the casino penthouse
+int interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641);
 
+// Activate certain entity sets for the casino penthouse
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Spa_Bar_Open');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Media_Bar_Open');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Arcade_Retro');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Bar_Clutter');
+ActivateInteriorEntitySet(interiorID, 'Set_Pent_Clutter_03');
+ActivateInteriorEntitySet(interiorID, 'Set_pent_bar_light_02');
+```
diff --git a/INTERIOR/DeactivateInteriorEntitySet.md b/INTERIOR/DeactivateInteriorEntitySet.md
@@ -9,8 +9,52 @@ aliases: ["0x420BD37289EEE162","_DISABLE_INTERIOR_PROP"]
 void DEACTIVATE_INTERIOR_ENTITY_SET(int interior, char* entitySetName);
 ```
 
+Deactivates the entity set with the specified name in the given interior.
+
+```
+NativeDB Introduced: v323
+```
 
 ## Parameters
-* **interior**: 
-* **entitySetName**: 
+* **interior**: The index of the interior.
+* **entitySetName**: The name of the entity set to deactivate.
+
+## Examples
+```lua
+-- Get the interior id for the casino penthouse
+local interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641)
+
+-- Deactivate certain entity sets for the casino penthouse
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Spa_Bar_Open')
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Media_Bar_Open')
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Arcade_Retro')
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Bar_Clutter')
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Clutter_03')
+DeactivateInteriorEntitySet(interiorID, 'Set_pent_bar_light_02')
+```
+```javascript
+// Get the interior id for the casino penthouse
+const interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641);
+
+// Deactivate certain entity sets for the casino penthouse
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Spa_Bar_Open');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Media_Bar_Open');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Arcade_Retro');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Bar_Clutter');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Clutter_03');
+DeactivateInteriorEntitySet(interiorID, 'Set_pent_bar_light_02');
+```
+```csharp
+using static CitizenFX.Core.Native.API;
+
+// Get the interior id for the casino penthouse
+int interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641);
 
+// Deactivate certain entity sets for the casino penthouse
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Spa_Bar_Open');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Media_Bar_Open');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Arcade_Retro');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Bar_Clutter');
+DeactivateInteriorEntitySet(interiorID, 'Set_Pent_Clutter_03');
+DeactivateInteriorEntitySet(interiorID, 'Set_pent_bar_light_02');
+```
diff --git a/INTERIOR/DisableMetroSystem.md b/INTERIOR/DisableMetroSystem.md
@@ -0,0 +1,35 @@
+---
+ns: INTERIOR
+aliases: ["0x9E6542F0CE8E70A3"]
+---
+## DISABLE_METRO_SYSTEM
+
+```c
+// 0x9E6542F0CE8E70A3 0x5EF9C5C2
+void DISABLE_METRO_SYSTEM(BOOL toggle);
+```
+
+Completely disables the metro system in the game.
+
+```
+NativeDB Introduced: v323
+```
+
+## Parameters
+* **toggle**: A boolean value indicating whether to disable (`true`) or enable (`false`) the metro system.
+
+## Examples
+```lua
+-- Disable metro system
+DisableMetroSystem(true)
+```
+```javascript
+// Disable metro system
+DisableMetroSystem(true);
+```
+```csharp
+using static CitizenFX.Core.Native.API;
+
+// Disable metro system
+DisableMetroSystem(true);
+```
diff --git a/INTERIOR/EnableExteriorCullModelThisFrame.md b/INTERIOR/EnableExteriorCullModelThisFrame.md
@@ -9,10 +9,33 @@ aliases: ["0xA97F257D0151A6AB","_HIDE_MAP_OBJECT_THIS_FRAME"]
 void ENABLE_EXTERIOR_CULL_MODEL_THIS_FRAME(Hash mapObjectHash);
 ```
 
+Culls exterior objects from rendering (G-buffer only) based on the model name hash. Primarily used in multiplayer apartments to hide the exterior shell of buildings. This native needs to be called every frame.
+
 ```
-This is the native that is used to hide the exterior of GTA Online apartment buildings when you are inside an apartment.
+NativeDB Introduced: v323
 ```
 
 ## Parameters
-* **mapObjectHash**: 
+* **mapObjectHash**: The hash of the model name to cull
+
+## Examples
+```lua
+CreateThread(function()
+    local buildingTopHash = GetHashKey("hei_kt1_08_buildingtop_a")
+    local emissiveHash = GetHashKey("hei_kt1_08_kt1_emissive_ema")
+    while (true) do
+        EnableExteriorCullModelThisFrame(buildingTopHash)
+        EnableExteriorCullModelThisFrame(emissiveHash)
+        Wait(0)
+    end
+end)
+```
+```javascript
+const buildingTopHash = GetHashKey("hei_kt1_08_buildingtop_a");
+const emissiveHash = GetHashKey("hei_kt1_08_kt1_emissive_ema");
 
+setTick(() => {
+    EnableExteriorCullModelThisFrame(buildingTopHash);
+    EnableExteriorCullModelThisFrame(emissiveHash);
+});
+```
diff --git a/INTERIOR/EnableScriptCullModelThisFrame.md b/INTERIOR/EnableScriptCullModelThisFrame.md
diff --git a/INTERIOR/EnableShadowCullModelThisFrame.md b/INTERIOR/EnableShadowCullModelThisFrame.md
@@ -0,0 +1,50 @@
+---
+ns: INTERIOR
+aliases: ["0x50C375537449F369", "_ENABLE_SCRIPT_CULL_MODEL_THIS_FRAME"]
+---
+## ENABLE_SHADOW_CULL_MODEL_THIS_FRAME
+
+```c
+// 0x50C375537449F369
+void ENABLE_SHADOW_CULL_MODEL_THIS_FRAME(cs_type(Any) Hash mapObjectHash);
+```
+
+Culls exterior objects from rendering (cascade shadows only) based on the model name hash. Primarily used in multiplayer apartments to hide the exterior structure of buildings. This native needs to be called every frame and is generally used with [`ENABLE_EXTERIOR_CULL_MODEL_THIS_FRAME`](#_0xA97F257D0151A6AB).
+
+```
+NativeDB Introduced: v323
+```
+
+## Parameters
+* **mapObjectHash**: The hash of the model name to cull from shadow rendering.
+
+## Examples
+```lua
+CreateThread(function()
+    local buildingTopHash = GetHashKey("hei_kt1_08_buildingtop_a")
+    local emissiveHash = GetHashKey("hei_kt1_08_kt1_emissive_ema")
+    while (true) do
+        -- hei_kt1_08_buildingtop_a
+        EnableExteriorCullModelThisFrame(buildingTopHash)
+        EnableShadowCullModelThisFrame(buildingTopHash)
+        -- hei_kt1_08_kt1_emissive_ema
+        EnableExteriorCullModelThisFrame(emissiveHash)
+        EnableShadowCullModelThisFrame(emissiveHash)
+        
+        Wait(0)
+    end
+end)
+```
+```javascript
+const buildingTopHash = GetHashKey("hei_kt1_08_buildingtop_a");
+const emissiveHash = GetHashKey("hei_kt1_08_kt1_emissive_ema");
+
+setTick(() => {
+    // hei_kt1_08_buildingtop_a
+    EnableExteriorCullModelThisFrame(buildingTopHash);
+    EnableShadowCullModelThisFrame(buildingTopHash);
+    // hei_kt1_08_kt1_emissive_ema
+    EnableExteriorCullModelThisFrame(emissiveHash);
+    EnableShadowCullModelThisFrame(emissiveHash);
+});
+```
diff --git a/INTERIOR/IsInteriorEntitySetActive.md b/INTERIOR/IsInteriorEntitySetActive.md
@@ -9,9 +9,43 @@ aliases: ["0x35F7DD45E8C0A16D","_IS_INTERIOR_PROP_ENABLED"]
 BOOL IS_INTERIOR_ENTITY_SET_ACTIVE(int interior, char* entitySetName);
 ```
 
+Determines whether the specified entity set is active within the given interior.
+
+```
+NativeDB Introduced: v323
+```
 
 ## Parameters
-* **interior**: 
-* **entitySetName**: 
+* **interior**: The index of the interior.
+* **entitySetName**: The name of the entity set to check.
 
 ## Return value
+A boolean value indicating whether the entity set is active (`true`) or not (`false`).
+
+## Examples
+```lua
+-- Check if the entity set `Set_Pent_Spa_Bar_Open` (casino penthouse) is active or not
+local interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641)
+local entitySet = "Set_Pent_Spa_Bar_Open"
+local isInteriorSetActive = IsInteriorEntitySetActive(interiorID, entitySet)
+
+print("Entity Set Active: " .. isInteriorSetActive)
+```
+```javascript
+// Check if the entity set `Set_Pent_Spa_Bar_Open` (casino penthouse) is active or not
+const interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641);
+const entitySet = "Set_Pent_Spa_Bar_Open";
+const isInteriorSetActive = IsInteriorEntitySetActive(interiorID, entitySet);
+
+console.log(`Entity Set Active: ${isInteriorSetActive}`);
+```
+```csharp
+using static CitizenFX.Core.Native.API;
+
+// Check if the entity set `Set_Pent_Spa_Bar_Open` (casino penthouse) is active or not
+int interiorID = GetInteriorAtCoords(976.6364, 70.29476, 115.1641);
+string entitySet = "Set_Pent_Spa_Bar_Open";
+bool isInteriorSetActive = IsInteriorEntitySetActive(interiorID, entitySet);
+
+Debug.WriteLine($"Entity Set Active: {isInteriorSetActive}");
+```
diff --git a/INTERIOR/N_0x9e6542f0ce8e70a3.md b/INTERIOR/N_0x9e6542f0ce8e70a3.md
diff --git a/INTERIOR/PinInteriorInMemory.md b/INTERIOR/PinInteriorInMemory.md
@@ -9,6 +9,33 @@ aliases: ["0x2CA429C029CCF247","_LOAD_INTERIOR"]
 void PIN_INTERIOR_IN_MEMORY(int interior);
 ```
 
+Instructs the interior system to load the specified interior into memory.
+
+```
+NativeDB Introduced: v323
+```
+
 ## Parameters
-* **interior**: 
+* **interior**: The index of the interior.
+
+## Examples
+```lua
+CreateThread(function()
 
+    local interiorCoords = vector3(976.6364, 70.29476, 115.1641)
+    -- Coordinates of the interior
+    local interiorID = GetInteriorAtCoords(interiorCoords.x, interiorCoords.y, interiorCoords.z)
+    
+    -- Load the interior into memory
+    PinInteriorInMemory(interiorID)
+    
+    -- Wait until the interior is ready
+    repeat
+        Wait(0)
+    until IsInteriorReady(interiorID)
+    
+    -- Since the interior is ready, we can now teleport the player to the interior
+    local playerPed = PlayerPedId()
+    SetEntityCoords(playerPed, interiorCoords.x, interiorCoords.y, interiorCoords.z)
+end)
+```