rdr3_discoveries Documentation

In the context of RDR3 discoveries, Composites are scenarios used to handle herb pickup. They allow you to spawn a herb entity and an associated scenario at specific coordinates.

Workflow for using Composites:

1. Identify the Composite Name: Use a string identifier like "COMPOSITE_LOOTABLE_EVERGREEN_HUCKLEBERRY_DEF" and convert it to a hash using GetHashKey().
2. Request the Composite: Use the native 0x73F0D0327BFA0812 to request the specific composite hash.
3. Wait for Loading: Poll the native 0x5E5D96BE25E9DF68 to ensure the composite has successfully loaded before attempting to spawn it.
4. Create the Composite: Once loaded, use the native 0x5B4BBE80AD5972DC to spawn the herb entity and scenario at the desired coordinates. This returns a composite_scenario_id.

Important Performance Note:

Creating too many composites can crash the game. To prevent this, you must manually delete unnecessary scenarios when they are no longer needed (e.g., when the player moves a certain distance away) using the native 0x5758B1EE0C3FD4AC.

-- Example of creating a composite
local composite_name = "COMPOSITE_LOOTABLE_EVERGREEN_HUCKLEBERRY_DEF"
local composite_name_hash = GetHashKey(composite_name)

-- Request COMPOSITE
Citizen.InvokeNative(0x73F0D0327BFA0812, composite_name_hash)

-- Wait for load (polling native 0x5E5D96BE25E9DF68)
-- ... (wait logic) ...

-- Create COMPOSITE
composite_scenario_id = Citizen.InvokeNative(0x5B4BBE80AD5972DC, composite_name_hash, x, y, z, 0.0, 0, Citizen.PointerValueInt(), -1, Citizen.ReturnResultAnyway())

-- Delete COMPOSITE scenario when done
Citizen.InvokeNative(0x5758B1EE0C3FD4AC, composite_scenario_id, 0)

Item interactions in RDR3 are categorized by their interaction type (e.g., PrimaryItem) and identified by specific string names and hexadecimal hashes. These interactions represent different states or animations for an item, such as BASE, INTRO, FLIP_TO_FRONT, FLIPPED_BASE, OUTRO, or HOLSTER.

Common interaction patterns include:

• Documents: Often involve a sequence of INTRO -> BASE -> FLIP_TO_FRONT/BACK -> FLIPPED_BASE -> OUTRO.
• Cigarette Cards: Use states like INTRO, BASE, FLIP_TO_FRONT, FLIPPED_BASE, and HOLSTER.
• Cylinders: Use states like HOLD, UNHOLSTER, or INSPECT_THEN_TAKE.

Developers can use these hashes to trigger specific item animations or inspect states in-game.

|             -             | CI_TAG_INSPECT_SHOTGUN_SEMI_AUTO                                                    |        0xF2AF4ADF         |
|        PrimaryItem        | CIGARETTE_CARD_W10-7_H6-5_SINGLE_BASE                                               |        0x18CEE7C6         |
|        PrimaryItem        | DOCUMENT_INSPECT@NEWSPAPER_BASE                                                    |        0xBBFFFCCD         |
|        PrimaryItem        | DOCUMENT_INSPECT@Paper_D2_H32_Rolled_READ                                           |        0x8A9DE39F         |

Blips in the game often change behavior based on the player's proximity or current activity. When working with blip logic, be aware of these common patterns:

• Area Dimming: Many mission and objective blips (like BLIP_STYLE_PROC_MISSION) apply AUTO_MODIFIER_AREA_DIM_WHEN_INSIDE when an entity has been inside the blip area for 100ms.
• Automatic Removal: Some blips, such as BLIP_STYLE_RANDOM_EVENT or BLIP_STYLE_SP_CORPSE_FADE, are designed to fade out and be removed after a specific duration (e.g., 3,000ms or 4,000ms).
• Vehicle-Based Hiding: Certain blips are hidden when the player is interacting with specific vehicles. For example, BLIP_STYLE_TRAIN applies BLIP_MODIFIER_HIDDEN when the player is driving a train, and BLIP_STYLE_TEMPORARY_HORSE applies BLIP_MODIFIER_HIDDEN when riding a horse.
• Radar Visibility: Some styles are explicitly set to be Hidden on Radar (e.g., BLIP_STYLE_SP_CORPSE, BLIP_STYLE_TOWN, or BLIP_STYLE_RCM_BOUNTY_HIDDEN) to prevent cluttering the mini-map while remaining visible on the main map.