Raptor internal broadcasts - coldrockgames/gml-raptor GitHub Wiki

raptor also uses the broadcasting system internally, all its messages are prefixed with raptor_<message_name> to avoid collisions with your own custom messages.

However, it might be handy to listen to some of the raptor-internal messages, as some of them can be of interest for your running game.

RAPTOR_* Broadcasts

Here is a list of the internal messages sent by raptor.

#macro string data
Popup and MessageBox Broadcasts
RAPTOR_BROADCAST_MSGBOX_OPENED raptor_msgbox_opened -
RAPTOR_BROADCAST_MSGBOX_CLOSED raptor_msgbox_closed -
RAPTOR_BROADCAST_POPUP_SHOWN raptor_popup_shown name
RAPTOR_BROADCAST_POPUP_HIDDEN raptor_popup_hidden name
RAPTOR_BROADCAST_POPUP_DESTROYED raptor_popup_destroyed name
Game Loading Broadcasts
RAPTOR_BROADCAST_DATA_GAME_LOADING raptor_gamefile_datamode_loading filename
RAPTOR_BROADCAST_DATA_GAME_LOADED raptor_gamefile_datamode_loaded filename,
data
RAPTOR_BROADCAST_GAME_LOADING raptor_gamefile_loading filename
RAPTOR_BROADCAST_GAME_LOADED raptor_gamefile_loaded filename
RAPTOR_BROADCAST_GAME_LOADING_NEW_ROOM
⚠️ The green room variable
holds the (new) current room
raptor_gamefile_loading_new_room filename
RAPTOR_BROADCAST_SAVEGAME_VERSION_CHECK raptor_savegame_version_check filename,
version
Game Saving Broadcasts
RAPTOR_BROADCAST_DATA_GAME_SAVING raptor_gamefile_datamode_saving filename
RAPTOR_BROADCAST_DATA_GAME_SAVED raptor_gamefile_datamode_saved filename,
success
RAPTOR_BROADCAST_GAME_SAVING raptor_gamefile_saving filename
RAPTOR_BROADCAST_GAME_SAVED raptor_gamefile_saved filename,
success
Sensor Broadcasts
RAPTOR_BROADCAST_SENSOR_ENTER raptor_sensor.enter -
RAPTOR_BROADCAST_SENSOR_STEP raptor_sensor.step -
RAPTOR_BROADCAST_SENSOR_LEAVE raptor_sensor.leave -
RAPTOR_BROADCAST_RADAR_ENTER raptor_radar.enter -
RAPTOR_BROADCAST_RADAR_STEP raptor_radar.step -
RAPTOR_BROADCAST_RADAR_LEAVE raptor_radar.leave -
RAPTOR_BROADCAST_CRADAR_ENTER raptor_cradar.enter -
RAPTOR_BROADCAST_CRADAR_STEP raptor_cradar.step -
RAPTOR_BROADCAST_CRADAR_LEAVE raptor_cradar.leave -
Other Broadcasts
RAPTOR_BROADCAST_WINDOW_SIZE_CHANGED
⚠️ Occurs only in HTML5 or when
WATCH_FOR_WINDOW_SIZE_CHANGE == true
raptor_window_size_changed -
RAPTOR_BROADCAST_SCENE_LOCKED
⚠️ See Scene Locking
raptor_scene_locked -
RAPTOR_BROADCAST_SCENE_UNLOCKED
⚠️ See Scene Locking
raptor_scene_unlocked -
RAPTOR_BROADCAST_MOUSE_UI_ENTER
(Mouse entered any UI control,
world scene will receive no events)
raptor_mouse_ui_enter -
RAPTOR_BROADCAST_MOUSE_UI_LEAVE raptor_mouse_ui_leave -
RAPTOR_BROADCAST_CAMERA_FLIGHT_STARTED raptor_camera_flight_started cam_index,
frames
RAPTOR_BROADCAST_CAMERA_FLIGHT_FINISHED raptor_camera_flight_finished cam_index,
frames

RAPTOR Broadcast Filters

There are also macros defined that create a message filter for groups of raptor broadcasts:

#macro string Covers
RAPTOR_MESSAGEBOX_BROADCAST_FILTER raptor_msgbox_* Catches open/close broadcasts for message boxes.
RAPTOR_POPUP_BROADCAST_FILTER raptor_popup_* Catches the show/hide/destroy broadcasts for popups.
RAPTOR_SAVEGAME_BROADCAST_FILTER raptor_gamefile_* Catches all loading and saving broadcasts from the savegame system (data files and full savegames)
RAPTOR_SCENE_LOCK_FILTER raptor_scene_* Catches the scene_locked/unlocked broadcasts.
RAPTOR_MOUSE_UI_BROADCAST_FILTER raptor_mouse_ui_* Catches the mouse-over-ui enter/leave broadcasts.
RAPTOR_CAMERA_FLIGHT_BROADCAST_FILTER raptor_camera_flight_*
RAPTOR_SENSOR_BROADCAST_FILTER raptor_sensor.*
RAPTOR_RADAR_BROADCAST_FILTER raptor_radar.*
RAPTOR_COLLISION_RADAR_BROADCAST_FILTER raptor_cradar.*
⚠️ **GitHub.com Fallback** ⚠️