ScummVM API documentation
Public Member Functions | Public Attributes | List of all members
AGS3::GameState Struct Reference

Public Member Functions

const Rect & GetMainViewport () const
 
const Rect & GetUIViewport () const
 
AGS::Engine::SpriteTransform GetGlobalTransform (bool full_frame_rend) const
 
bool IsAutoRoomViewport () const
 
PViewport GetRoomViewport (int index) const
 
const std::vector< PViewport > & GetRoomViewportsZOrdered () const
 
PViewport GetRoomViewportAt (int x, int y) const
 
Rect GetRoomViewportAbs (int index) const
 
void SetAutoRoomViewport (bool on)
 
void SetMainViewport (const Rect &viewport)
 
void SetUIViewport (const Rect &viewport)
 
void UpdateViewports ()
 
void InvalidateViewportZOrder ()
 
PCamera GetRoomCamera (int index) const
 
void UpdateRoomCameras ()
 
Point RoomToScreen (int roomx, int roomy)
 
int RoomToScreenX (int roomx)
 
int RoomToScreenY (int roomy)
 
VpPoint ScreenToRoom (int scrx, int scry, bool clip_viewport=true)
 
VpPoint ScreenToRoomDivDown (int scrx, int scry)
 
void CreatePrimaryViewportAndCamera ()
 
PViewport CreateRoomViewport ()
 
ScriptViewport * RegisterRoomViewport (int index, int32_t handle=0)
 
void DeleteRoomViewport (int index)
 
int GetRoomViewportCount () const
 
PCamera CreateRoomCamera ()
 
ScriptCamera * RegisterRoomCamera (int index, int32_t handle=0)
 
void DeleteRoomCamera (int index)
 
int GetRoomCameraCount () const
 
ScriptViewport * GetScriptViewport (int index)
 
ScriptCamera * GetScriptCamera (int index)
 
bool IsIgnoringInput () const
 
void SetIgnoreInput (int timeout_ms)
 
void ClearIgnoreInput ()
 
void SetWaitSkipResult (int how, int data=0)
 
void SetWaitKeySkip (const KeyInput &kp)
 
int GetWaitSkipResult () const
 
bool IsBlockingVoiceSpeech () const
 
bool IsNonBlockingVoiceSpeech () const
 
bool ShouldPlayVoiceSpeech () const
 
void ReadCustomProperties_v340 (Shared::Stream *in, GameDataVersion data_ver)
 
void WriteCustomProperties_v340 (Shared::Stream *out, GameDataVersion data_ver) const
 
void ReadFromSavegame (Shared::Stream *in, GameDataVersion data_ver, GameStateSvgVersion svg_ver, AGS::Engine::RestoredData &r_data)
 
void WriteForSavegame (Shared::Stream *out) const
 
void FreeProperties ()
 
void FreeViewportsAndCameras ()
 

Public Attributes

int score = 0
 
int usedmode = 0
 
int disabled_user_interface = 0
 
int gscript_timer = 0
 
int debug_mode = 0
 
int32_t globalvars [MAXGLOBALVARS] {}
 
int messagetime = 0
 
int usedinv = 0
 
int inv_top = 0
 
int inv_numdisp = 0
 
int inv_numorder = 0
 
int inv_numinline = 0
 
int text_speed = 0
 
int sierra_inv_color = 0
 
int talkanim_speed = 0
 
int inv_item_wid = 0
 
int inv_item_hit = 0
 
int speech_text_shadow = 0
 
int swap_portrait_side = 0
 
int speech_textwindow_gui = 0
 
int follow_change_room_timer = 0
 
int totalscore = 0
 
int skip_display = 0
 
int no_multiloop_repeat = 0
 
int roomscript_finished = 0
 
int used_inv_on = 0
 
int no_textbg_when_voice = 0
 
int max_dialogoption_width = 0
 
int no_hicolor_fadein = 0
 
int bgspeech_game_speed = 0
 
int bgspeech_stay_on_display = 0
 
int unfactor_speech_from_textlength = 0
 
int mp3_loop_before_end = 0
 
int speech_music_drop = 0
 
int in_cutscene = 0
 
int fast_forward = 0
 
int room_width = 0
 
int room_height = 0
 
int game_speed_modifier = 0
 
int score_sound = 0
 
int takeover_data = 0
 
int replay_hotkey_unused = 0
 
int dialog_options_x = 0
 
int dialog_options_y = 0
 
int narrator_speech = 0
 
int ambient_sounds_persist = 0
 
int lipsync_speed = 0
 
int close_mouth_speech_time = 0
 
int disable_antialiasing = 0
 
int text_speed_modifier = 0
 
HorAlignment text_align = kHAlignNone
 
int speech_bubble_width = 0
 
int min_dialogoption_width = 0
 
int disable_dialog_parser = 0
 
int anim_background_speed = 0
 
int top_bar_backcolor = 0
 
int top_bar_textcolor = 0
 
int top_bar_bordercolor = 0
 
int top_bar_borderwidth = 0
 
int top_bar_ypos = 0
 
int screenshot_width = 0
 
int screenshot_height = 0
 
int top_bar_font = 0
 
HorAlignment speech_text_align = kHAlignNone
 
int auto_use_walkto_points = 0
 
int inventory_greys_out = 0
 
int skip_speech_specific_key = 0
 
int abort_key = 0
 
int fade_to_red = 0
 
int fade_to_green = 0
 
int fade_to_blue = 0
 
int show_single_dialog_option = 0
 
int keep_screen_during_instant_transition = 0
 
int read_dialog_option_colour = 0
 
int stop_dialog_at_end = 0
 
int speech_portrait_placement = 0
 
int speech_portrait_x = 0
 
int speech_portrait_y = 0
 
int speech_display_post_time_ms = 0
 
int dialog_options_highlight_color = 0
 
int32_t reserved [5] {}
 
long randseed = 0
 
int player_on_region = 0
 
int screen_is_faded_out = 0
 
int check_interaction_only = 0
 
int bg_frame = 0
 
int bg_anim_delay = 0
 
int music_vol_was = 0
 
short wait_counter = 0
 
int8 wait_skipped_by = 0
 
int wait_skipped_by_data = 0
 
short mboundx1 = 0
 
short mboundx2 = 0
 
short mboundy1 = 0
 
short mboundy2 = 0
 
int fade_effect = 0
 
int bg_frame_locked = 0
 
int32_t globalscriptvars [MAXGSVALUES] {}
 
int cur_music_number = 0
 
int music_repeat = 0
 
int music_master_volume = 0
 
int digital_master_volume = 0
 
char walkable_areas_on [MAX_WALK_AREAS] {}
 
short screen_flipped = 0
 
int entered_at_x = 0
 
int entered_at_y = 0
 
int entered_edge = 0
 
bool voice_avail
 
SpeechMode speech_mode
 
int speech_skip_style = 0
 
int32_t script_timers [MAX_TIMERS] {}
 
int sound_volume = 0
 
int speech_volume = 0
 
int normal_font = 0
 
int speech_font = 0
 
int8 key_skip_wait = 0
 
int swap_portrait_lastchar = 0
 
int swap_portrait_lastlastchar = 0
 
bool separate_music_lib = false
 
int in_conversation = 0
 
int screen_tint = 0
 
int num_parsed_words = 0
 
short parsed_words [MAX_PARSED_WORDS] {}
 
char bad_parsed_word [100] {}
 
int raw_color = 0
 
int32_t raw_modified [MAX_ROOM_BGFRAMES] {}
 
Shared::PBitmap raw_drawing_surface = 0
 
short filenumbers [MAXSAVEGAMES] {}
 
int room_changes = 0
 
int mouse_cursor_hidden = 0
 
int silent_midi = 0
 
int silent_midi_channel = 0
 
int current_music_repeating = 0
 
unsigned long shakesc_delay = 0
 
int shakesc_amount = 0
 
int shakesc_length = 0
 
int rtint_red = 0
 
int rtint_green = 0
 
int rtint_blue = 0
 
int rtint_level = 0
 
int rtint_light = 0
 
bool rtint_enabled = false
 
int end_cutscene_music = 0
 
int skip_until_char_stops = 0
 
int get_loc_name_last_time = 0
 
int get_loc_name_save_cursor = 0
 
int restore_cursor_mode_to = 0
 
int restore_cursor_image_to = 0
 
short music_queue_size = 0
 
short music_queue [MAX_QUEUED_MUSIC] {}
 
short new_music_queue_size = 0
 
short crossfading_out_channel = 0
 
short crossfade_step = 0
 
short crossfade_out_volume_per_step = 0
 
short crossfade_initial_volume_out = 0
 
short crossfading_in_channel = 0
 
short crossfade_in_volume_per_step = 0
 
short crossfade_final_volume_in = 0
 
QueuedAudioItem new_music_queue [MAX_QUEUED_MUSIC] {}
 
char takeover_from [50] {}
 
AGS::Shared::String playmp3file_name
 
char globalstrings [MAXGLOBALSTRINGS][MAX_MAXSTRLEN] {}
 
char lastParserEntry [MAX_MAXSTRLEN] {}
 
AGS::Shared::String game_name
 
int ground_level_areas_disabled = 0
 
int next_screen_transition = 0
 
int gamma_adjustment = 0
 
short temporarily_turned_off_character = 0
 
short inv_backwards_compatibility = 0
 
std::vector< int > gui_draw_order
 
std::unordered_set< AGS::Shared::String > do_once_tokens
 
int text_min_display_time_ms = 0
 
int ignore_user_input_after_text_timeout_ms = 0
 
int32_t default_audio_type_volumes [MAX_AUDIO_TYPES] {}
 
std::vector< AGS::Shared::StringIMap > charProps
 
AGS::Shared::StringIMap invProps [MAX_INV]
 
bool speech_has_voice = false
 
bool speech_voice_blocking = false
 
bool speech_in_post_state = false
 
int overlay_count = 0
 
int overlay_creation_id = 0
 
int complete_overlay_on = 0
 
int text_overlay_on = 0
 
int speech_text_schandle = 0
 
int speech_face_schandle = 0
 
int shake_screen_yoff = 0
 
The documentation for this struct was generated from the following file: