Game Events Client
Game Events is a powerful module to listen for and respond to in-game events. This module provides simplified access to the game's event system, automatically handling event registration, data parsing, and callback triggering.
JO Functions
jo.gameEvents.listen()
Register a listener for a specific game event
Syntax
lua
jo.gameEvents.listen(eventName, callback)Parameters
eventName : string
The name of the event to listen for, or "all" to listen for all events
callback : function
The function that will be called when the event is triggered
Example
lua
jo.gameEvents.listen("EVENT_ENTITY_DAMAGED", function(data)
print("Target:", data.target_entity)
print("Origin:", data.initiator_entity)
print("Weapon:", data.weapon)
log(data)
end)Game events list
| Event Name | data |
|---|---|
EVENT_BUCKED_OFF | rider - integer mount - integer value_2 - integer |
EVENT_CALCULATE_LOOT | value_0 - integer value_1 - integer inventory_item - integer consumable_action - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer initiator_entity - integer target_entity - integer value_25 - integer |
EVENT_CALM_PED | initiator_entity - integer target_entity - integer calm_type - integer is_fully_calmed - boolean |
EVENT_CARRIABLE_UPDATE_CARRY_STATE | target_entity - integer perpitrator_entity - integer carrier_entity - integer is_on_horse - boolean is_on_ground - boolean |
EVENT_CARRIABLE_PROMPT_INFO_REQUEST | target_entity - integer carriable_action - integer value_2 - integer vehicle_entity - integer value_4 - integer value_5 - integer |
EVENT_CARRIABLE_VEHICLE_STOW_START | value_0 - integer target_entity - integer vehicle_entity - integer value_3 - integer value_4 - integer |
EVENT_CARRIABLE_VEHICLE_STOW_COMPLETE | value_0 - integer vehicle_entity - integer is_item_to_add_cancelled - boolean |
EVENT_CHALLENGE_GOAL_COMPLETE | challenge_goal - integer |
EVENT_CHALLENGE_GOAL_UPDATE | challenge_goal - integer |
EVENT_CHALLENGE_REWARD | challenge_reward - integer value_1 - integer value_2 - integer |
EVENT_CONTAINER_INTERACTION | initiator_entity - integer target_entity - integer value_2 - integer is_container_closed_after_interaction - boolean |
EVENT_CRIME_CONFIRMED | crime_type - integer criminal_entity - integer witness_entity - integer |
EVENT_DAILY_CHALLENGE_STREAK_COMPLETED | is_daily_challenge_streak_completed - boolean |
EVENT_ENTITY_BROKEN | target_entity - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer coord_x - float coord_y - float coord_z - float |
EVENT_ENTITY_DAMAGED | target_entity - integer initiator_entity - integer weapon - integer ammo - integer damage_amount - float value_5 - integer coord_x - float coord_y - float coord_z - float |
EVENT_ENTITY_DESTROYED | target_entity - integer initiator_entity - integer weapon - integer ammo - integer damage_amount - float value_5 - integer coord_x - float coord_y - float coord_z - float |
EVENT_ENTITY_DISARMED | target_entity - integer initiator_entity - integer weapon - integer value_3 - integer |
EVENT_ENTITY_EXPLOSION | initiator_entity - integer value_1 - integer weapon - integer coord_x - float coord_y - float coord_z - float |
EVENT_ENTITY_HOGTIED | target_entity - integer initiator_entity - integer value_2 - integer |
EVENT_HEADSHOT_BLOCKED_BY_HAT | target_entity - integer initiator_entity - integer |
EVENT_HELP_TEXT_REQUEST | entity - integer help_text - integer value_2 - integer inventory_item - integer |
EVENT_HITCH_ANIMAL | initiator_entity - integer target_entity - integer is_animal_hitched - boolean hitching_type - integer |
EVENT_HOGTIED_ENTITY_PICKED_UP | target_entity - integer initiator_entity - integer |
EVENT_HORSE_BROKEN | initiator_entity - integer target_entity - integer event_type - integer |
EVENT_IMPENDING_SAMPLE_PROMPT | value_0 - integer inventory_item - integer |
EVENT_INVENTORY_ITEM_PICKED_UP | inventory_item - integer entity_model - integer is_item_was_used - boolean is_item_was_bought - boolean target_entity - integer |
EVENT_INVENTORY_ITEM_REMOVED | |
EVENT_ITEM_PROMPT_INFO_REQUEST | target_entity - integer prompt_info - integer inventory_item - integer |
EVENT_LOOT | num_given_rewards - integer reward - integer inventory_item - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer value_10 - integer value_11 - integer num - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer weapon - integer value_23 - integer value_24 - integer value_25 - integer initiator_entity - integer target_entity - integer looted_entity_model - integer looted_composite - integer value_30 - integer value_31 - integer value_32 - integer value_33 - integer value_34 - integer value_35 - integer |
EVENT_LOOT_COMPLETE | initiator_entity - integer target_entity - integer is_loot_success - boolean |
EVENT_LOOT_PLANT_START | num_given_rewards - integer reward - integer inventory_item - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer value_10 - integer value_11 - integer num - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer weapon - integer value_23 - integer value_24 - integer value_25 - integer initiator_entity - integer target_entity - integer looted_entity_model - integer looted_composite - integer value_30 - integer value_31 - integer value_32 - integer value_33 - integer value_34 - integer value_35 - integer |
EVENT_LOOT_VALIDATION_FAIL | fail_reason - integer target_entity - integer |
EVENT_MISS_INTENDED_TARGET | initiator_entity - integer target_entity - integer weapon - integer |
EVENT_MOUNT_OVERSPURRED | initiator_entity - integer target_entity - integer horse_rage_amount - float num_overspurred - integer max_num_overspurred - integer value_5 - integer |
EVENT_NETWORK_AWARD_CLAIMED | request - integer value_1 - integer value_2 - integer value_3 - integer result_code - integer award - integer awarded_xp_amount - integer awarded_rank_amount - integer awarded_cash_amount - integer awarded_gold_amount - integer value_10 - integer value_11 - integer |
EVENT_NETWORK_BOUNTY_REQUEST_COMPLETE | request - integer value_1 - integer value_2 - integer value_3 - integer result_code - integer total_value - integer pay_off_value - integer |
EVENT_NETWORK_BULLET_IMPACTED_MULTIPLE_PEDS | initiator_entity - integer num_impacted - integer num_killed - integer num_incapacitated - integer |
EVENT_NETWORK_CASHINVENTORY_TRANSACTION | transaction - integer value_1 - integer value_2 - integer result_code - integer items_amount - integer action - integer |
EVENT_NETWORK_CREW_CREATION | is_creation_successful - boolean crew - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer |
EVENT_NETWORK_CREW_DISBANDED | is_disbanding_successful - boolean value_1 - integer |
EVENT_NETWORK_CREW_INVITE_RECEIVED | crew - integer inviter - integer inviter_name - integer inviter_rank - integer inviter_rank_icon - integer inviter_rank_icon_color - integer inviter_rank_icon_bg_color - integer inviter_rank_icon_border_color - integer inviter_rank_icon_border_color - integer inviter_rank_icon_border_color - integer has_message - integer |
EVENT_NETWORK_CREW_JOINED | joined_crew - integer value_1 - integer |
EVENT_NETWORK_CREW_KICKED | kicked_crew - integer value_1 - integer |
EVENT_NETWORK_CREW_LEFT | left_crew - integer value_1 - integer |
EVENT_NETWORK_CREW_RANK_CHANGE | crew - integer rank_order - integer promotion - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer |
EVENT_NETWORK_DAMAGE_ENTITY | target_entity - integer initiator_entity - integer damage_amount - float is_victim_destroyed - boolean is_victim_incapacitated - boolean weapon - integer ammo - integer instigated_weapon - integer victim_speed - float damager_speed - float is_responsible_for_collision - boolean is_headshot - boolean is_with_melee_weapon - boolean is_victim_executed - boolean victim_bled_out - boolean damager_was_scoped_in - boolean damager_special_ability_active - boolean victim_hogtied - boolean victim_mounted - boolean victim_in_vehicle - boolean victim_in_cover - boolean damager_shot_last_bullet - boolean victim_killed_by_stealth - boolean victim_killed_by_takedown - boolean victim_knocked_out - boolean is_victim_tranquilized - boolean victim_killed_by_standard_melee - boolean victim_mission_entity - boolean victim_fleeing - boolean victim_in_combat - boolean value_30 - integer is_suicide - boolean |
EVENT_NETWORK_GANG | value_0 - integer event_type - integer sender - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer |
EVENT_NETWORK_GANG_WAYPOINT_CHANGED | waypoint_type - integer waypoint - integer type - integer |
EVENT_NETWORK_HOGTIE_BEGIN | target_entity - integer initiator_entity - integer |
EVENT_NETWORK_HOGTIE_END | target_entity - integer initiator_entity - integer |
EVENT_NETWORK_HUB_UPDATE | update - integer |
EVENT_NETWORK_INCAPACITATED_ENTITY | target_entity - integer initiator_entity - integer weapon - integer damage_amount - float |
EVENT_NETWORK_LASSO_ATTACH | target_entity - integer initiator_entity - integer |
EVENT_NETWORK_LASSO_DETACH | target_entity - integer initiator_entity - integer |
EVENT_NETWORK_LOOT_CLAIMED | request - integer value_1 - integer value_2 - integer value_3 - integer result_code - integer loot_entity_model - integer value_6 - integer status - integer value_8 - integer |
EVENT_NETWORK_MINIGAME_REQUEST_COMPLETE | request - integer value_1 - integer value_2 - integer value_3 - integer isSuccess - boolean MinigameErrorCodeHash - integer |
EVENT_NETWORK_PED_DISARMED | target_entity - integer initiator_entity - integer weapon - integer |
EVENT_NETWORK_PED_HAT_SHOT_OFF | target_entity - integer initiator_entity - integer weapon - integer |
EVENT_NETWORK_PERMISSION_CHECK_RESULT | request - integer result_code - integer |
EVENT_NETWORK_PICKUP_COLLECTION_FAILED | value_0 - integer player - integer pickup_type - integer |
EVENT_NETWORK_PICKUP_RESPAWNED | target_entity - integer value_1 - integer |
EVENT_NETWORK_PLAYER_COLLECTED_PICKUP | target_entity - integer initiator_entity - integer pickup_type - integer value_3 - integer pickup_entity_model - integer pickup_ammo_amount - integer pickup_ammo_type - integer value_7 - integer |
EVENT_NETWORK_PLAYER_COLLECTED_PORTABLE_PICKUP | collected_pickup_network - integer player - integer value_2 - integer |
EVENT_NETWORK_PLAYER_DROPPED_PORTABLE_PICKUP | dropped_pickup_network - integer player - integer value_2 - integer |
EVENT_NETWORK_PLAYER_JOIN_SCRIPT | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer player - integer value_9 - integer value_10 - integer NumThreads - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer value_23 - integer value_24 - integer value_25 - integer value_26 - integer value_27 - integer value_28 - integer value_29 - integer value_30 - integer value_31 - integer value_32 - integer value_33 - integer value_34 - integer value_35 - integer value_36 - integer value_37 - integer value_38 - integer value_39 - integer participant - integer |
EVENT_NETWORK_PLAYER_LEFT_SCRIPT | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer player - integer value_9 - integer value_10 - integer NumThreads - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer value_23 - integer value_24 - integer value_25 - integer value_26 - integer value_27 - integer value_28 - integer value_29 - integer value_30 - integer value_31 - integer value_32 - integer value_33 - integer value_34 - integer value_35 - integer value_36 - integer value_37 - integer value_38 - integer value_39 - integer participant - integer |
EVENT_NETWORK_PLAYER_JOIN_SESSION | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer player - integer value_9 - integer |
EVENT_NETWORK_PLAYER_LEFT_SESSION | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer player - integer value_9 - integer |
EVENT_NETWORK_PLAYER_MISSED_SHOT | initiator_entity - integer weapon - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer |
EVENT_NETWORK_POSSE_CREATED | isSuccess - boolean posse - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer |
EVENT_NETWORK_POSSE_DATA_CHANGED | value_0 - integer value_1 - integer |
EVENT_NETWORK_POSSE_DISBANDED | is_success - boolean posse - integer |
EVENT_NETWORK_POSSE_EX_ADMIN_DISBANDED | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer |
EVENT_NETWORK_POSSE_EX_INACTIVE_DISBANDED | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer |
EVENT_NETWORK_POSSE_JOINED | is_success - integer posse - integer |
EVENT_NETWORK_POSSE_LEADER_SET_ACTIVE | posse - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer network_gamer_handle - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer |
EVENT_NETWORK_POSSE_LEFT | posse - integer |
EVENT_NETWORK_POSSE_MEMBER_DISBANDED | posse - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer network_gamer_handle - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer |
EVENT_NETWORK_POSSE_MEMBER_JOINED | posse - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer network_gamer_handle - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer |
EVENT_NETWORK_POSSE_MEMBER_KICKED | posse - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer network_gamer_handle - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer |
EVENT_NETWORK_POSSE_MEMBER_LEFT | posse - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer network_gamer_handle - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer |
EVENT_NETWORK_POSSE_MEMBER_SET_ACTIVE | posse - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer network_gamer_handle - integer value_10 - integer value_11 - integer value_12 - integer value_13 - integer value_14 - integer value_15 - integer value_16 - integer value_17 - integer value_18 - integer value_19 - integer value_20 - integer value_21 - integer value_22 - integer |
EVENT_NETWORK_PROJECTILE_ATTACHED | initiator_entity - integer target_entity - integer coord_x - float coord_y - float coord_z - float weapon - integer |
EVENT_NETWORK_PROJECTILE_NO_DAMAGE_IMPACT | initiator_entity - integer ammo - integer |
EVENT_NETWORK_REVIVED_ENTITY | target_entity - integer initiator_entity - integer |
EVENT_NETWORK_SESSION_EVENT | event_type - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer value_8 - integer value_9 - integer |
EVENT_NETWORK_SESSION_MERGE_END | session_message - integer |
EVENT_NETWORK_SESSION_MERGE_START | session_message - integer |
EVENT_NETWORK_VEHICLE_LOOTED | initiator_entity - integer target_entity - integer value_2 - integer |
EVENT_NETWORK_VEHICLE_UNDRIVABLE | target_entity - integer initiator_entity - integer value_2 - integer |
EVENT_OBJECT_INTERACTION | initiator_entity - integer target_entity - integer inventory_item - integer inventory_item_quantity - integer value_4 - integer value_5 - integer value_6 - integer value_7 - integer scenario_point - integer value_9 - integer |
EVENT_PED_ANIMAL_INTERACTION | initiator_entity - integer target_entity - integer interaction_type - integer |
EVENT_PED_CREATED | target_entity - integer |
EVENT_PED_DESTROYED | target_entity - integer |
EVENT_PED_HAT_KNOCKED_OFF | target_entity - integer hat_entity - integer |
EVENT_PED_WHISTLE | initiator_entity - integer whistle_type - integer |
EVENT_PICKUP_CARRIABLE | initiator_entity - integer target_entity - integer is_pickup_done_from_parent - boolean carrier_mount_entity - integer |
EVENT_PLACE_CARRIABLE_ONTO_PARENT | initiator_entity - integer carriable_entity - integer carrier_entity - integer value_3 - integer is_a_pelt - boolean inventory_item - integer |
EVENT_PLAYER_COLLECTED_AMBIENT_PICKUP | pickup_name - integer target_entity - integer initiator_entity - integer pickup_model - integer value_4 - integer value_5 - integer inventory_item_quantity - integer inventory_item - integer |
EVENT_PLAYER_ESCALATED_PED | initiator_entity - integer target_entity - integer |
EVENT_PLAYER_HAT_EQUIPPED | initiator_entity - integer hat_entity - integer hat_drawble - integer hat_albedo - integer hat_normal - integer hat_material - integer hat_palette - integer hat_tint1 - integer hat_tint2 - integer hat_tint3 - integer |
EVENT_PLAYER_HAT_KNOCKED_OFF | target_entity - integer initiator_entity - integer hat_entity - integer value_3 - integer value_4 - integer |
EVENT_PLAYER_HORSE_AGITATED_BY_ANIMAL | horse_entity - integer agitated_animal_entity - integer value_2 - integer value_3 - integer |
EVENT_PLAYER_MOUNT_WILD_HORSE | target_entity - integer |
EVENT_PLAYER_PROMPT_TRIGGERED | prompt_type - integer value_1 - integer target_entity - integer value_3 - integer coord_x - float coord_y - float coord_z - float discoverable_entity_type - integer value_8 - integer kit_emote_action - integer |
EVENT_RAN_OVER_PED | value_0 - integer target_entity - integer |
EVENT_REVIVE_ENTITY | target_entity - integer initiator_entity - integer used_inventory_item - integer |
EVENT_SCENARIO_ADD_PED | script_uid - integer value_1 - integer |
EVENT_SCENARIO_DESTROY_PROP | script_uid - integer value_1 - integer |
EVENT_SCENARIO_REMOVE_PED | script_uid - integer value_1 - integer |
EVENT_SHOCKING_ITEM_STOLEN | initiator_entity - integer target_entity - integer carriable_entity - integer |
EVENT_SHOT_FIRED_BULLET_IMPACT | target_entity - integer |
EVENT_SHOT_FIRED_WHIZZED_BY | initiator_entity - integer |
EVENT_STAT_VALUE_CHANGED | stat_value_type - integer value_1 - integer |
EVENT_TRIGGERED_ANIMAL_WRITHE | target_entity - integer initiator_entity - integer |
EVENT_UI_ITEM_INSPECT_ACTIONED | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer |
EVENT_UI_QUICK_ITEM_USED | value_0 - integer value_1 - integer value_2 - integer value_3 - integer value_4 - integer value_5 - integer |
EVENT_VEHICLE_CREATED | target_entity - integer |
EVENT_VEHICLE_DESTROYED | target_entity - integer |