Raptor Modules - coldrockgames/doc-scriptor GitHub Wiki

There are, at the time of writing this documentation, two modules included in scriptor, which you can #include in your scripts, if you need them.

raptor Module

#include raptor

This module provides access to the most important macros and global variables from Raptor, such as:

• BROADCASTER
• ROOMCONTROLLER
• GAMECONTROLLER
• GAME_SPEED

Included Macros:

Here is a list of all macros available in the raptor module:

#macro GAMESTARTER			global.__gamestarter
#macro GAMECONTROLLER			global.__game_controller
#macro ROOMCONTROLLER			global.__room_controller
#macro UI_ROOT				global.__ui_root
#macro BROADCASTER			global.__broadcaster
#macro GLOBALDATA			global.__global_data
#macro AUDIOSETTINGS			global.__audiosettings
#macro GAMESETTINGS			global._game_settings
#macro SAVEGAME_SAVE_IN_PROGRESS	global.__savegame_save_in_progress
#macro SAVEGAME_LOAD_IN_PROGRESS	global.__savegame_load_in_progress
#macro GUI_POPUP_VISIBLE		global.__popup_visible
#macro SECRET_WORD_TRACKER		global.__secret_word_tracker
#macro GAME_SPEED			global.__game_speed
#macro DELTA_TIME_SECS			global.__delta_time_secs
#macro DELTA_TIME_SECS_REAL		global.__delta_time_secs_real
#macro PARTSYS				global.__room_particle_system

#macro MOUSE_CURSOR			global.__mouse_cursor
#macro GUI_MOUSE_X_PREVIOUS		global.__gui_mouse_xprevious
#macro GUI_MOUSE_Y_PREVIOUS		global.__gui_mouse_yprevious
#macro GUI_MOUSE_X			global.__gui_mouse_x
#macro GUI_MOUSE_Y			global.__gui_mouse_y
#macro GUI_MOUSE_DELTA_X		global.__gui_mouse_xmove
#macro GUI_MOUSE_DELTA_Y		global.__gui_mouse_ymove
#macro GUI_MOUSE_HAS_MOVED		global.__gui_mouse_has_moved
#macro MOUSE_X_PREVIOUS			global.__world_mouse_xprevious
#macro MOUSE_Y_PREVIOUS			global.__world_mouse_yprevious
#macro MOUSE_DELTA_X			global.__world_mouse_xmove
#macro MOUSE_DELTA_Y			global.__world_mouse_ymove
#macro MOUSE_HAS_MOVED			global.__world_mouse_has_moved
#macro WINDOW_SIZE_X			global.__window_size_x
#macro WINDOW_SIZE_Y			global.__window_size_y
#macro WINDOW_SIZE_DELTA_X		global.__window_size_xmove
#macro WINDOW_SIZE_DELTA_Y		global.__window_size_ymove
#macro WINDOW_SIZE_X_PREVIOUS		global.__window_size_xprevious
#macro WINDOW_SIZE_Y_PREVIOUS		global.__window_size_yprevious
#macro WINDOW_SIZE_HAS_CHANGED		global.__window_size_has_changed

#macro GAME_CHANNEL_STRING		global.__game_channel_string
#macro GAME_VERSION_STRING		global.__game_version_string
#macro GAME_VERSION_MAJOR		global.__game_version_major
#macro GAME_VERSION_MINOR		global.__game_version_minor
#macro GAME_VERSION_BUILD		global.__game_version_build	

raptor_logger Module

#include raptor_logger

This module provides full logging capabilities from raptor, making it especially useful during development for debugging and tracking script behavior.

Included Macros:

#macro RAPTOR_LOGGER	global.__raptor_logger

#macro vlog		RAPTOR_LOGGER.log_verbose
#macro dlog		RAPTOR_LOGGER.log_debug
#macro ilog		RAPTOR_LOGGER.log_info
#macro wlog		RAPTOR_LOGGER.log_warning
#macro elog		RAPTOR_LOGGER.log_error
#macro flog		RAPTOR_LOGGER.log_fatal