Warhorse ScripBind documentation
ContentsIndexHome
PreviousUpNext
CScriptBindGame Methods

The methods of the CScriptBindGame class are listed here.

 
Name 
Description 
 
Syntax: Game.AddSaveLock( lockName, uiDescription )
Disable save 
 
Syntax: Game.AllowTutorials()
Allow showing tutorials (eg. after dialogue, cut scene, video, etc.)
 
 
Syntax: Game.BlockInfoText(category)
Prevents InfoTexts with given category from being displayed to player. Categories are defined in db table infotext_category (everyone can add there) and are exported to lua as constants with prefix "itc_". 
 
Syntax: Game.BlockTutorials()
Block all tutorial messages except synced ones.
 
 
 
 
Syntax: Game.CreatePrefab(self.id,props.filePrefabLibrary,props.ObjectVariation.sPrefabVariation,props.nMaxSpawn);
Creates the runtime prefab in the same way as SpawnPrefab, but doesn't spawn the content of the prefab. Only creates the prefab and links to given entity id. 
 
Syntax: Game.ShadowplayStartStop()
Sends [Alt] + [F9] to start/stop the Shadowplay capturing Only for Windows 
 
! _RELEASE
 
 
This is DebugDrawAABB, a member of class CScriptBindGame. 
 
This is DebugDrawCone, a member of class CScriptBindGame. 
 
Debug 
 
This is DebugDrawPersistanceDirection, a member of class CScriptBindGame. 
 
 
 
Syntax: Game.HideTutorial()
Hide actually displayed tutorial message.
 
 
Syntax: Game.HideInfoText()
Hides info text sooner.
 
 
 
 
Syntax: Game.HideTutorial(name)
Hides tutorial if currently show. If tutorial is not show right now, nothing happens.
 
 
Syntax: Game.InventoryModeOnlyCodex( enable )
Do not allow player to switch to anything else than codex in player inventory. Other inventories (looting, shopping, ...) are not affected. 
 
if the code is compiled on a "*Demo*" configuration
 
 
Syntax: local isLoading = Game.IsLoadingEngineSaveGame();
Determines whether a game save is being loaded (Cry Engine load only!!)
 
 
Syntax: Game.IsPlayer()
Checks if the given entity is player.
 
 
 
 
Syntax: Game.LogGameEvent(text)
Localization will be done for you (if the message contains @...)
 
 
 
 
Syntax: Game.PauseGame( bool pause )
Pauses the game.
 
 
! Quick load 
 
! Quick save 
 
Syntax: Game.RemoveSaveLock( lockNamed )
Enable save 
 
This is ResetEntity, a member of class CScriptBindGame. 
 
Syntax: Game.ResetTutorial(name)
Resets the tutorials making it possible to display again. 
 
Syntax: Game.SaveGameViaResting()
Creates 'Auto' save
 
 
Syntax: Game.SendInfoText(text, [force_clear_current_queue], [category], [time])
Shows info text. Does not need to be hidden (hides automaticaly).
 
 
 
 
 
 
 
 
Syntax: Game.ShowItemsTransfer()
Displays UI message informing about item transfered into/from players inventory
 
 
 
 
Syntax: Game.ShowOverlayTutorial(text)
Show tutorial in overlay window, parameter is name of tutorial
 
 
Syntax: Game.ShowStatCheckResult(stat, result)
Show something like "Persuade: succeeded". Stat: shortcut name of stat (eg. "spc"), result: true=succeeded, false=failed.
 
 
Syntax: Game.ShowTutorial(name)
Shows tutorial message. Other tutorial parameters are specified in the game table.
 
 
 
 
Syntax: Actor.StopTimeWarp()
Stops time warp effect
 
 
Syntax: Game.UnblockInfoText(category)
Reverts effect of Game.BlockInfoText(category). 
 
Time effects ============================================= Syntax: Actor.WarpTime(float wantedSpeed, float duration)
Slowdown/speedup global time for given time period 
 
Name 
Description 
 
 
Copyright (c) 2012. All rights reserved.