Game Functions and Variables Documentation

Functions and Properties

Return Type	Function Information
`float`	`InitD[]The original values of the item's 8 D input values are they are stored in the .qst file, regardles of whether they have been modified by ZScript.`
`int`	`GetCurScreen()Retrieves the number of the current screen within the current map.`
`int`	`GetCurDMapScreen()Retrieves the number of the current screen within the current DMap.`
`int`	`GetCurLevel()Retrieves the number of the dungeon level of the current DMap. Multiple DMaps can have the same dungeon level - this signifies that they share a map, compass, level keys and such.`
`int`	`GetCurMap()Retrieves the number of the current map.`
`int`	`GetCurDMap()Returns the number of the current DMap.`
`int`	`DMapFlags[]An array of 512 integers, containing the DMap's flags ORed (\|) together. Use the 'DMF_' constants, or the 'DMapFlag()' functions from std.zh if you are not comfortable with binary.`
`int`	`DMapLevel[]An array of 512 integers containing each DMap's level`
`int`	`DMapCompass[]An array of 512 integers containing each DMap's compass screen`
`int`	`DMapContinue[]An array of 512 integers containing each DMap's continue screen`
`int`	`DMapMIDI[]An array of 512 integers containing each DMap's MIDI. Positive numbers are for custom MIDIs, and negative values are used for the built-in game MIDIs. Because of the way DMap MIDIs are handled internally, however, built-in MIDIs besides the overworld, dungeon, and level 9 songs won't match up with Game->PlayMIDI() and Game->GetMIDI().`
`void`	`GetDMapName(int DMap, int buffer[])Loads DMap with ID 'DMap's name into 'buffer'. See std.zh for appropriate buffer size.`
`void`	`GetDMapTitle(int DMap, int buffer[])Loads DMap with ID 'DMap's title into 'buffer'. See std.zh for appropriate buffer size.`
`void`	`GetDMapIntro(int DMap, int buffer[])Loads DMap with ID 'DMap's intro string into 'buffer'. See std.zh for appropriate buffer size.`
`int`	`DMapOffset[]An array of 512 integers containing the X offset of each DMap. Game->DMapOffset is read-only; while setting it is not syntactically incorrect, it does nothing.`
`int`	`DMapMap[]An array of 512 integers containing the map used by each DMap. Game->DMapMap is read-only; while setting it is not syntactically incorrect, it does nothing.`
`int`	`NumDeathsThe number of times Link has perished during this quest.`
`int`	`CheatThe current cheat level of the quest player.`
`int`	`TimeReturns the time elapsed in this quest, in 60ths of a second. The return value is undefined if TimeValid is false (see below).`
`bool`	`TimeValidTrue if the elapsed quest time can be determined for the current quest.`
`bool`	`HasPlayedThis value is true if the current quest session was loaded from a saved game, false if the quest was started fresh.`
`bool`	`StandaloneThis value is true if the game is running in standalone mode, false if not. Game->Standalone is read-only; while setting it is not syntactically incorrect, it does nothing.`
`int`	`GuyCount[]The number of NPCs (enemies and guys) on screen i of this map, where i is the index used to access this array. This array is exclusively used to determine which enemies had previously been killed, and thus won't return, when you re-enter a screen.`
`int`	`ContinueDMapThe DMap where Link will be respawned after quitting and reloading the game.`
`int`	`ContinueScreenThe map screen where Link will be respawned after quitting and reloading the game.`
`int`	`LastEntranceDMapThe DMap where Link will be respawned after dying and continuing.`
`int`	`LastEntranceScreenThe map screen where Link will be respawned after dying and continuing.`
`int`	`Counter[]The current value of the game counters. Use the CR_ constants in std.zh to index into this array.`
`int`	`MCounter[]The current maximum value of the game counters. Use the CR_ constants in std.zh to index into this array.`
`int`	`DCounter[]The current value of the game drain counters. Use the CR_ constants in std.zh to index into this array. Note that if the player hasn't acquired the '1/2 Magic Upgrade' yet then setting the CR_MAGIC drain counter to a negative value will drain the magic counter by 2 per frame rather than 1.`
`int`	`Generic[]An array of miscellaneous game values, such as number of heart containers and magic drain rate. Use the GEN_ constants in std.zh to index into this array.`
`int`	`LItems[]The exploration items (map, compass, boss key etc.) of dungeon level i currently under the possession of the player, where i is the index used to access this array. Each element of this array consists of flags OR'd (\|) together; use the LI_ constants in std.zh to set or compare these values.`
`int`	`LKeys[]The number of level keys of level i currently under the possession of the player, where i is the index used to access this array.`
`int`	`GetScreenFlags(int map, int screen, int flagset)Returns the screen flags from screen 'screen' on map 'map' interpreted in the same way as Screen->Flags`
`int`	`GetScreenEFlags(int map, int screen, int flagset)Returns the enemy flags from screen 'screen' on map 'map' interpreted in the same way as Screen->EFlags`
`bool`	`GetScreenState(int map, int screen, int flag)As with State, but retrieves the miscellaneous flags of any screen not just the current one. This function is undefined if map is less than 1 or greater than the maximum map number of your quest, or if screen is greater than 127. Note: Screen numbers in ZQuest are usually displayed in hexadecimal. Use the ST_ constants in std.zh for the flag parameter.`
`void`	`SetScreenState(int map, int screen, int flag, bool value)As with State, but sets the miscellaneous flags of any screen, not just the current one. This function is undefined if map is less than 1 or greater than the maximum map number of your quest, or if screen is greater than 127. Note: Screen numbers in ZQuest are usually displayed in hexadecimal. Use the ST_ constants in std.zh for the flag parameter.`
`float`	`GetScreenD(int screen, int reg)Retrieves the value of D[reg] on the given screen of the current DMap.`
`void`	`SetScreenD(int screen, int reg, float value)Sets the value of D[reg] on the given screen of the current DMap.`
`float`	`GetDMapScreenD(int dmap, int screen, int reg)Retrieves the value of D[reg] on the given screen of the given DMap.`
`void`	`SetDMapScreenD(int dmap, int screen, int reg, float value)Sets the value of D[reg] on the given screen of the given DMap.`
`itemdata`	`LoadItemData(int item)Retrieves the itemdata pointer corresponding to the given item. Use the item pointer ID variable or I_ constants in std.zh as values.`
`void`	`PlaySound(int soundid)Plays one of the quest's sound effects. Use the SFX_ constants in std.zh as values of soundid.`
`void`	`PlayMIDI(int MIDIid)Changes the current screen MIDI to MIDIid. Will revert to the DMap (or screen) MIDI upon leaving the screen.`
`int`	`GetMIDI()Returns the current screen MIDI that is playing. Positive numbers are for custom MIDIs, and negative values are used for the built-in game MIDIs.`
`bool`	`PlayEnhancedMusic(int filename[], int track)Play the specified enhanced music if it's available. If the music cannot be played, the current music will continue. The music will revert to normal upon leaving the screen. Returns true if the music file was loaded successfully. The filename cannot be more than 255 characters. If the music format does not support multiple tracks, the track argument will be ignored.`
`void`	`GetDMapMusicFilename(int dmap, int buf[])Load the filename of the given DMap's enhanced music into buf. buf should be at least 256 elements in size.`
`int`	`GetDMapMusicTrack(int dmap)Returns the given DMap's enhanced music track. This is valid but meaningless if the music format doesn't support multiple tracks.`
`void`	`SetDMapEnhancedMusic(int dmap, int filename[], int track)Sets the specified DMap's enhanced music to the given filename and track number. If the music format does not support multiple tracks, the track argument will be ignored. The filename must not be more than 255 characters.`
`int`	`GetComboData(int map, int screen, int position)Grabs a particular combo reference from anywhere in the game world, based on map (NOT DMap), screen number, and position. Don't forget that the screen index should be in hexadecimal, and that maps are counted from 1 upwards. Position is considered an index, treated the same way as in Screen->ComboD[].`
`void`	`SetComboData(int map, int screen, int position, int value)Sets a particular combo reference anywhere in the game world, based on map (NOT DMap), screen number, and position. Don't forget that the screen index should be in hexadecimal, and that maps are counted from 1 upwards. Position is considered an index, treated the same way as in Screen->ComboD[].`
`int`	`GetComboCSet(int map, int screen, int position)Grabs a particular combo's CSet from anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboC[].`
`void`	`SetComboCSet(int map, int screen, int position, int value)Sets a particular combo's CSet anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboC[].`
`int`	`GetComboFlag(int map, int screen, int position)Grabs a particular combo's placed flag from anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboF[].`
`void`	`SetComboFlag(int map, int screen, int position, int value)Sets a particular combo's placed flag anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboF[].`
`int`	`GetComboType(int map, int screen, int position)Grabs a particular combo's type from anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboT[]. Note that you are grabbing an actual combo attribute as referenced by the combo on screen you're referring to.`
`void`	SetComboType(int map, int screen, int position, int value)Sets a particular combo's type anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboT[]. Note that you are grabbing an actual combo attribute as referenced by the combo on screen you're referring to, which means that setting this attribute will affect ALL references to this combo throughout the quest.
`int`	`GetComboInherentFlag(int map, int screen, int position)Grabs a particular combo's inherent flag from anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboI[]. Note that you are grabbing an actual combo attribute as referenced by the combo on screen you're referring to.`
`void`	SetComboInherentFlag(int map, int screen, int position, int value)Sets a particular combo's inherent flag anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboI[]. Note that you are grabbing an actual combo attribute as referenced by the combo on screen you're referring to, which means that setting this attribute will affect ALL references to this combo throughout the quest.
`int`	`GetComboSolid(int map, int screen, int position)Grabs a particular combo's solidity flag from anywhere in the game world, based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboS[]. Note that you are grabbing an actual combo attribute as referenced by the combo on screen you're referring to.`
`void`	SetComboSolid(int map, int screen, int position, int value)Sets a particular combo's solidity anywhere in the game world based on map (NOT DMap), screen number, and position. Position is considered an index, treated the same way as in Screen->ComboS[]. Note that you are grabbing an actual combo attribute as referenced by the combo on screen you're referring to, which means that setting this attribute will affect ALL references to this combo throughout the quest.
`int`	`ComboTile(int combo)Returns the tile used by combo 'combo'`
`void`	`GetSaveName(int buffer[])Loads the current save file's name into 'buffer' Buffer should be at least 9 elements long`
`void`	`SetSaveName(int name[])Sets the current file's save name to 'name' Buffer should be no more than 9 elements`
`void`	`End()Ends the current game and returns to the file select screen`
`void`	`Save()Saves the current game`
`bool`	`ShowSaveScreen()Displays the save screen. Returns true if the user chose to save, false otherwise.`
`void`	`ShowSaveQuitScreen()Displays the save and quit screen.`
`void`	`GetMessage(int string, int buffer[])Loads 'string' into 'buffer'. Use the function from std.zh to remove trailing ' ' characters whilst loading.`
`int`	`GetFFCScript(int name[])Returns the number of the script with the given name or -1 if there is no such script.`
`bool`	`ClickToFreezeEnabledIf this is false, the "Click to Freeze" setting will not function, ensuring that the script can use the mouse freely. This overrides the setting rather than changing it, so remembering and restoring the initial value is unnecessary.`