Not Stable Yet!
This article is part of the Witcher 3 scripting community documentation, which is considered to be UNSTABLE until after the release of the Blood and Wine DLC. Edits to these pages may be overwritten without notice!
CR4Game | |
---|---|
Signature |
import class CR4Game extends CCommonGame |
Parent |
CCommonGame |
Version |
1.12 |
Path |
/game/r4Game.ws |
ISerializable > IScriptable > CObject > CGame > CCommonGame
Public Functions
ActivateHorseCamera
AddDynamicallySpawnedBoatHandle
public final function AddDynamicallySpawnedBoatHandle(handle : EntityHandle)
- Parameters:
- handle : EntityHandle
- Location:
- starts @ line 1788, ends @ line 1812
CanLog
CanTrackQuest
public function CanTrackQuest(questEntry : CJournalQuest) : bool
- Parameters:
- questEntry : CJournalQuest
- Returns:
- Location:
- starts @ line 1705, ends @ line 1740
ChangeActiveUser
import final function ChangeActiveUser()
- Location:
- starts @ line 526, ends @ line 526
ClearRichPresence
public final function ClearRichPresence(presence : name)
- Parameters:
- presence : name
- Location:
- starts @ line 305, ends @ line 319
DisplaySystemHelp
import final function DisplaySystemHelp()
- Location:
- starts @ line 289, ends @ line 289
DisplayUserProfileSystemDialog
import final function DisplayUserProfileSystemDialog()
- Location:
- starts @ line 290, ends @ line 290
EnableLog
public function EnableLog(enable : bool)
- Parameters:
- enable : bool
- Location:
- starts @ line 210, ends @ line 213
EnableNewGamePlus
import final function EnableNewGamePlus(enable : bool)
- Parameters:
- enable : bool
- Location:
- starts @ line 541, ends @ line 541
EnableUberMovement
function EnableUberMovement(flag : bool)
- Parameters:
- flag : bool
- Location:
- starts @ line 60, ends @ line 63
FirePostponedPreAttackEvents
function FirePostponedPreAttackEvents()
- Location:
- starts @ line 1768, ends @ line 1786
GameplayFactRemoveFromTimer
public function GameplayFactRemoveFromTimer(timerID : int)
- Parameters:
- timerID : int
- Location:
- starts @ line 1542, ends @ line 1562
GameplayFactsAdd
GameplayFactsQuerySum
GameplayFactsRemove
public function GameplayFactsRemove(factName : string)
- Parameters:
- factName : string
- Location:
- starts @ line 1527, ends @ line 1539
GameplayFactsSet
GetActiveUserDisplayName
import final function GetActiveUserDisplayName() : string
- Returns:
- Location:
- starts @ line 528, ends @ line 528
GetBuffImmunitiesForActor
import final function GetBuffImmunitiesForActor(actor : CActor) : CBuffImmunity
- Parameters:
- actor : CActor
- Returns:
- Location:
- starts @ line 266, ends @ line 266
GetCityLightManager
import final function GetCityLightManager() : CCityLightManager
- Returns:
- Location:
- starts @ line 230, ends @ line 230
GetCommonMapManager
import final function GetCommonMapManager() : CCommonMapManager
- Returns:
- Location:
- starts @ line 222, ends @ line 222
GetCurrentZone
public function GetCurrentZone() : EZoneName
- Returns:
- Location:
- starts @ line 1250, ends @ line 1253
GetDifficultyMode
public function GetDifficultyMode() : EDifficultyMode
- Returns:
- EDifficultyMode
- Location:
- starts @ line 1606, ends @ line 1619
GetFastForwardSystem
import final function GetFastForwardSystem() : CGameFastForwardSystem
- Returns:
- Location:
- starts @ line 238, ends @ line 238
GetFocusModeController
import final function GetFocusModeController() : CFocusModeController
- Returns:
- Location:
- starts @ line 77, ends @ line 77
GetGameCamera
import final function GetGameCamera() : CCustomCamera
- Returns:
- Location:
- starts @ line 263, ends @ line 263
GetGamerProfile
public function GetGamerProfile() : W3GamerProfile
- Returns:
- Location:
- starts @ line 650, ends @ line 657
GetGlobalEventsManager
public function GetGlobalEventsManager() : CR4GlobalEventsScriptsDispatcher
- Returns:
- Location:
- starts @ line 243, ends @ line 250
GetGlobalEventsScriptsDispatcher
import final function GetGlobalEventsScriptsDispatcher() : CR4GlobalEventsScriptsDispatcher
- Returns:
- Location:
- starts @ line 236, ends @ line 236
GetGuiManager
import final function GetGuiManager() : CR4GuiManager
- Returns:
- Location:
- starts @ line 234, ends @ line 234
GetGwintManager
import final function GetGwintManager() : CR4GwintManager
- Returns:
- Location:
- starts @ line 1742, ends @ line 1742
GetInteractionsManager
import final function GetInteractionsManager() : CInteractionsManager
- Returns:
- Location:
- starts @ line 228, ends @ line 228
GetJournalManager
import final function GetJournalManager() : CWitcherJournalManager
- Returns:
- Location:
- starts @ line 224, ends @ line 224
GetKinectSpeechRecognizer
import final function GetKinectSpeechRecognizer() : CR4KinectSpeechRecognizerListenerScriptProxy
- Returns:
- Location:
- starts @ line 283, ends @ line 283
GetLootManager
import final function GetLootManager() : CR4LootManager
- Returns:
- Location:
- starts @ line 226, ends @ line 226
GetLowestDifficultyUsed
public function GetLowestDifficultyUsed() : EDifficultyMode
- Returns:
- EDifficultyMode
- Location:
- starts @ line 1016, ends @ line 1019
GetMenuToOpen
GetMiniMapExteriorTextureExtension
GetMiniMapExteriorTextureSize
GetMiniMapInteriorTextureExtension
GetMiniMapInteriorTextureSize
GetMiniMapMaxLod
GetMiniMapMaxZoom
GetMiniMapMinLod
GetMiniMapMinZoom
GetMiniMapSize
GetMiniMapSmaxX
GetMiniMapSmaxY
GetMiniMapSminX
GetMiniMapSminY
GetMiniMapTextureSize
GetMiniMapTileCount
GetMiniMapVmaxX
GetMiniMapVmaxY
GetMiniMapVminX
GetMiniMapVminY
GetMiniMapZoom12
GetMiniMapZoom23
GetMiniMapZoom34
GetMonsterParamForActor
import final function GetMonsterParamForActor(actor : CActor, out val : CMonsterParam) : bool
- Parameters:
- actor : CActor
- out val : CMonsterParam
- Returns:
- Location:
- starts @ line 268, ends @ line 268
GetMonsterParamsForActor
GetNewGameDefinitionFilename
public function GetNewGameDefinitionFilename() : string
- Returns:
- Location:
- starts @ line 1241, ends @ line 1244
GetPlatform
GetR4ReactionManager
public function GetR4ReactionManager() : CR4ReactionManager
- Returns:
- Location:
- starts @ line 1601, ends @ line 1604
GetRecentDialogOrCutsceneEndGameTime
public final function GetRecentDialogOrCutsceneEndGameTime() : GameTime
- Returns:
- Location:
- starts @ line 1163, ends @ line 1166
GetResourceAliases
GetSavedEnchanterFunds
public final function GetSavedEnchanterFunds() : int
- Returns:
- Location:
- starts @ line 1168, ends @ line 1171
GetSecondScreenManager
import final function GetSecondScreenManager() : CR4SecondScreenManagerScriptProxy
- Returns:
- Location:
- starts @ line 232, ends @ line 232
GetSpawnDifficultyMode
public function GetSpawnDifficultyMode() : EDifficultyMode
- Returns:
- EDifficultyMode
- Location:
- starts @ line 1680, ends @ line 1687
GetSurfacePostFX
import final function GetSurfacePostFX() : CGameplayFXSurfacePost
- Returns:
- Location:
- starts @ line 220, ends @ line 220
GetSyncAnimManager
public function GetSyncAnimManager() : W3SyncAnimationManager
- Returns:
- Location:
- starts @ line 350, ends @ line 358
GetTimescalePriority
public function GetTimescalePriority(src : ETimescaleSource) : int
- Parameters:
- src : ETimescaleSource
- Returns:
- Location:
- starts @ line 449, ends @ line 452
GetTimescaleSource
public function GetTimescaleSource(src : ETimescaleSource) : name
- Parameters:
- src : ETimescaleSource
- Returns:
- Location:
- starts @ line 444, ends @ line 447
GetTutorialSystem
import final function GetTutorialSystem() : CR4TutorialSystem
- Returns:
- Location:
- starts @ line 286, ends @ line 286
GetUIGamepadScaleGain
public function GetUIGamepadScaleGain() : float
- Returns:
- Location:
- starts @ line 1358, ends @ line 1361
GetUIHorizontalFrameScale
public function GetUIHorizontalFrameScale() : float
- Returns:
- Location:
- starts @ line 1338, ends @ line 1341
GetUIOpacity
public function GetUIOpacity() : float
- Returns:
- Location:
- starts @ line 1373, ends @ line 1376
GetUIScale
GetUIVerticalFrameScale
public function GetUIVerticalFrameScale() : float
- Returns:
- Location:
- starts @ line 1325, ends @ line 1328
GetVolumePathManager
import final function GetVolumePathManager() : CVolumePathManager
- Returns:
- Location:
- starts @ line 271, ends @ line 271
GetWindAtPoint
GetWindAtPointForVisuals
GetWorldDLCExtender
import public final function GetWorldDLCExtender() : CR4WorldDLCExtender
- Returns:
- Location:
- starts @ line 1903, ends @ line 1903
InitializeEffectManager
public function InitializeEffectManager()
- Location:
- starts @ line 1010, ends @ line 1014
IsBlackscreenOrFading
public function IsBlackscreenOrFading() : bool
- Returns:
- Location:
- starts @ line 1744, ends @ line 1747
IsBoatMarkedForDestroy
IsContentAvailable
IsDebugQuestMenuEnabled
import final function IsDebugQuestMenuEnabled() : bool
- Returns:
- Location:
- starts @ line 538, ends @ line 538
IsDialogOrCutscenePlaying
public final function IsDialogOrCutscenePlaying() : bool
- Returns:
- Location:
- starts @ line 1158, ends @ line 1161
IsEffectManagerInitialized
public function IsEffectManagerInitialized() : bool
- Returns:
- Location:
- starts @ line 1002, ends @ line 1008
IsFocusModeActive
public function IsFocusModeActive() : bool
- Returns:
- Location:
- starts @ line 196, ends @ line 205
IsUberMovementEnabled
public function IsUberMovementEnabled() : bool
- Returns:
- Location:
- starts @ line 65, ends @ line 68
LoadHudSettings
public function LoadHudSettings()
- Location:
- starts @ line 1383, ends @ line 1398
LoadQuestLevels
public function LoadQuestLevels(filePath : string) : void
- Parameters:
- filePath : string
- Returns:
- void
- Location:
- starts @ line 560, ends @ line 569
NotifyOpeningJournalEntry
import final function NotifyOpeningJournalEntry(jorunalEntry : CJournalBase)
- Parameters:
- jorunalEntry : CJournalBase
- Location:
- starts @ line 240, ends @ line 240
OnConfigValueChanged
OnPlayerChanged
public function OnPlayerChanged()
- Location:
- starts @ line 1644, ends @ line 1676
OnTick
public function OnTick()
- Location:
- starts @ line 659, ends @ line 672
OnUserDialogCallback
import final function OnUserDialogCallback(message, action : int)
- Parameters:
- message
- action : int
- Location:
- starts @ line 294, ends @ line 294
OpenPopup
public function OpenPopup(DataObject : W3PopupData) : void
- Parameters:
- DataObject : W3PopupData
- Returns:
- void
- Location:
- starts @ line 1315, ends @ line 1318
PopulateMenuQueueConfig
PopulateMenuQueueMainAlways
PopulateMenuQueueMainOnce
PopulateMenuQueueStartupAlways
PopulateMenuQueueStartupOnce
ProgressToContentAvailable
RequestMenuWithBackground
public function RequestMenuWithBackground(menu : name, backgroundMenu : name, optional initData : IScriptable)
- Parameters:
- menu : name
- backgroundMenu : name
- optional initData : IScriptable
- Location:
- starts @ line 1292, ends @ line 1313
SaveUserSettings
import final function SaveUserSettings()
- Location:
- starts @ line 297, ends @ line 297
SetActiveUserPromiscuous
import final function SetActiveUserPromiscuous()
- Location:
- starts @ line 524, ends @ line 524
SetCurrentZone
public function SetCurrentZone(tag : name)
- Parameters:
- tag : name
- Location:
- starts @ line 1255, ends @ line 1258
SetDeathSaveLockId
public function SetDeathSaveLockId(i : int)
- Parameters:
- i : int
- Location:
- starts @ line 1363, ends @ line 1366
SetEnvironmentID
public function SetEnvironmentID(id : int)
- Parameters:
- id : int
- Location:
- starts @ line 363, ends @ line 366
SetIsCutscenePlaying
public function SetIsCutscenePlaying(b : bool)
- Parameters:
- b : bool
- Location:
- starts @ line 1179, ends @ line 1182
SetIsDialogOrCutscenePlaying
public function SetIsDialogOrCutscenePlaying(b : bool)
- Parameters:
- b : bool
- Location:
- starts @ line 1075, ends @ line 1156
SetIsRespawningInLastCheckpoint
public function SetIsRespawningInLastCheckpoint()
- Location:
- starts @ line 83, ends @ line 86
SetLowestDifficultyUsed
public function SetLowestDifficultyUsed(d : EDifficultyMode)
- Parameters:
- d : EDifficultyMode
- Location:
- starts @ line 1021, ends @ line 1024
SetMenuToOpen
public function SetMenuToOpen(menu : name)
- Parameters:
- menu : name
- Location:
- starts @ line 1287, ends @ line 1290
SetRichPresence
import final function SetRichPresence(presence : name)
- Parameters:
- presence : name
- Location:
- starts @ line 291, ends @ line 291
SetRunReactionSceneDialog
public function SetRunReactionSceneDialog(val : bool)
- Parameters:
- val : bool
- Location:
- starts @ line 1073, ends @ line 1073
SetSavedEnchanterFunds
public final function SetSavedEnchanterFunds(value : int)
- Parameters:
- value : int
- Location:
- starts @ line 1173, ends @ line 1176
SetUIGamepadScaleGain
public function SetUIGamepadScaleGain(value : float)
- Parameters:
- value : float
- Location:
- starts @ line 1353, ends @ line 1356
SetUIHorizontalFrameScale
public function SetUIHorizontalFrameScale(value : float)
- Parameters:
- value : float
- Location:
- starts @ line 1330, ends @ line 1336
SetUIOpacity
public function SetUIOpacity(value : float)
- Parameters:
- value : float
- Location:
- starts @ line 1368, ends @ line 1371
SetUIScale
public function SetUIScale(value : float)
- Parameters:
- value : float
- Location:
- starts @ line 1343, ends @ line 1346
SetUIVerticalFrameScale
public function SetUIVerticalFrameScale(value : float)
- Parameters:
- value : float
- Location:
- starts @ line 1320, ends @ line 1323
ShouldForceInstallVideo
import final function ShouldForceInstallVideo() : bool
- Returns:
- Location:
- starts @ line 536, ends @ line 536
ShowSteamControllerBindingPanel
import final function ShowSteamControllerBindingPanel() : bool
- Returns:
- Location:
- starts @ line 73, ends @ line 73
StartNewGamePlus
import final function StartNewGamePlus(save : SSavegameInfo) : ENewGamePlusStatus
- Parameters:
- save : SSavegameInfo
- Returns:
- ENewGamePlusStatus
- Location:
- starts @ line 544, ends @ line 544
StartSepiaEffect
StopSepiaEffect
SummonPlayerHorse
import final function SummonPlayerHorse(teleportToSafeSpot : bool, createEntityHelper : CR4CreateEntityHelper)
- Parameters:
- teleportToSafeSpot : bool
- createEntityHelper : CR4CreateEntityHelper
- Location:
- starts @ line 274, ends @ line 274
ToggleInput
import final function ToggleInput()
- Location:
- starts @ line 278, ends @ line 278
ToggleMenus
import final function ToggleMenus()
- Location:
- starts @ line 277, ends @ line 277
UnloadQuestLevels
public function UnloadQuestLevels(filePath : string) : void
- Parameters:
- filePath : string
- Returns:
- void
- Location:
- starts @ line 571, ends @ line 580
UpdateRichPresence
public final function UpdateRichPresence(presence : name)
- Parameters:
- presence : name
- Location:
- starts @ line 299, ends @ line 303
UpdateStatsForDifficultyLevel
public function UpdateStatsForDifficultyLevel(difficulty : EDifficultyMode)
- Parameters:
- difficulty : EDifficultyMode
- Location:
- starts @ line 1689, ends @ line 1703
VibrateControllerHard
public final function VibrateControllerHard(optional duration : float)
- Parameters:
- optional duration : float
- Location:
- starts @ line 1868, ends @ line 1884
VibrateControllerLight
public final function VibrateControllerLight(optional duration : float)
- Parameters:
- optional duration : float
- Location:
- starts @ line 1850, ends @ line 1866
VibrateControllerVeryHard
public final function VibrateControllerVeryHard(optional duration : float)
- Parameters:
- optional duration : float
- Location:
- starts @ line 1886, ends @ line 1902
VibrateControllerVeryLight
public final function VibrateControllerVeryLight(optional duration : float)
- Parameters:
- optional duration : float
- Location:
- starts @ line 1832, ends @ line 1848
getColorBlindMode
public function getColorBlindMode() : bool
- Returns:
- Location:
- starts @ line 1272, ends @ line 1275
isUserSignedIn
setColorBlindMode
public function setColorBlindMode(value : bool)
- Parameters:
- value : bool
- Location:
- starts @ line 1276, ends @ line 1279
setDialogDisplayDisabled
Public Vars
damageMgr
public var damageMgr : W3DamageManager
- Location:
- defined @ line 329
deathSaveLockId
public var deathSaveLockId : int
- Location:
- defined @ line 46
effectMgr
public var effectMgr : W3GameEffectManager
- Location:
- defined @ line 332
envMgr
public saved var envMgr : W3EnvironmentManager
- Location:
- defined @ line 338
expGlobalMod_kills
public var expGlobalMod_kills : float
- Location:
- defined @ line 345
expGlobalMod_quests
public var expGlobalMod_quests : float
- Location:
- defined @ line 346
expGlobalModifiers
public var expGlobalModifiers : C2dArray
- Location:
- defined @ line 344
globalEventsScriptsDispatcherInternal
var globalEventsScriptsDispatcherInternal : CR4GlobalEventsScriptsDispatcher
- Location:
- defined @ line 242
hudSettings
public var hudSettings : C2dArray
- Location:
- defined @ line 326
isCutscenePlaying
public var isCutscenePlaying : bool
- Location:
- defined @ line 42
isDialogDisplayDisabled
public var isDialogDisplayDisabled : bool
- Location:
- defined @ line 43
isRespawningInLastCheckpoint
public var isRespawningInLastCheckpoint : bool
- Location:
- defined @ line 79
logEnabled
var logEnabled : bool
- Location:
- defined @ line 207
m_runReactionSceneDialog
public var m_runReactionSceneDialog : bool
- Location:
- defined @ line 1072
params
import var params : W3GameParams
- Location:
- defined @ line 322
playerStatisticsSettings
public var playerStatisticsSettings : C2dArray
- Location:
- defined @ line 325
postponedPreAttackEvents
var postponedPreAttackEvents : array<SPostponedPreAttackEvent>
- Location:
- defined @ line 1753
questLevelsContainer
runewordMgr
public var runewordMgr : W3RunewordManager
- Location:
- defined @ line 340
witcherLog
public var witcherLog : W3GameLog
- Location:
- defined @ line 45
zoneName
saved var zoneName : EZoneName
- Location:
- defined @ line 38
Protected Vars
isColorBlindMode
protected var isColorBlindMode : bool
- Location:
- defined @ line 1271
Event Handlers
OnAfterLoadingScreenGameStart
event OnAfterLoadingScreenGameStart()
- Location:
- starts @ line 732
OnBeforeWorldChange
event OnBeforeWorldChange(worldName : string)
- Parameters:
- worldName : string
- Overrides member from: CCommonGame
- Location:
- starts @ line 718
OnControllerDisconnected
event OnControllerDisconnected()
- Location:
- starts @ line 837
OnControllerReconnected
event OnControllerReconnected()
- Location:
- starts @ line 820
OnDifficultyChanged
event OnDifficultyChanged(newDifficulty : int)
OnGameEnded
event OnGameEnded()
- Location:
- starts @ line 1027
OnGameLoadInitFinished
event OnGameLoadInitFinished()
- Location:
- starts @ line 106
OnGameLoadInitFinishedSuccess
event OnGameLoadInitFinishedSuccess()
- Location:
- starts @ line 191
OnGameSaveListUpdated
event OnGameSaveListUpdated()
- Location:
- starts @ line 88
OnGameStarted
OnGameStarting
OnGiveReward
OnHandleWorldChange
event OnHandleWorldChange()
- Location:
- starts @ line 712
OnPreAttackEvent
event OnPreAttackEvent(entity : CGameplayEntity, animEventName : name, animEventType : EAnimationEventType, data : CPreAttackEventData, animInfo : SAnimationEventAnimInfo)
- Parameters:
- entity : CGameplayEntity
- animEventName : name
- animEventType : EAnimationEventType
- data : CPreAttackEventData
- animInfo : SAnimationEventAnimInfo
- Location:
- starts @ line 1755
OnRefreshUIScaling
event OnRefreshUIScaling()
- Location:
- starts @ line 1400
OnSaveCompleted
event OnSaveCompleted(type : ESaveGameType, succeeded : bool)
- Parameters:
- type : ESaveGameType
- succeeded : bool
- Location:
- starts @ line 763
OnSaveStarted
event OnSaveStarted(type : ESaveGameType)
- Parameters:
- type : ESaveGameType
- Location:
- starts @ line 757
OnSignInCancelled
event OnSignInCancelled()
- Location:
- starts @ line 519
OnSignInStarted
event OnSignInStarted()
- Location:
- starts @ line 514
OnSpawnPlayerHorse
event OnSpawnPlayerHorse()
- Location:
- starts @ line 1408
OnTutorialMessageForChoiceLineChosen
event OnTutorialMessageForChoiceLineChosen(flags : int)
- Parameters:
- flags : int
- Location:
- starts @ line 1463
OnTutorialMessageForChoiceLines
event OnTutorialMessageForChoiceLines(flags : int)
- Parameters:
- flags : int
- Location:
- starts @ line 1454
OnUserSignedIn
event OnUserSignedIn()
- Location:
- starts @ line 500
OnUserSignedOut
event OnUserSignedOut()
- Location:
- starts @ line 507