Witcher Wiki
Don't have an account?
Register
Register
Witcher Wiki
Witcher Wiki
Official wiki
14,206
pages
in: The Witcher 3 classes

W3Class CCommonGame

Sign in to edit
Substances Graveir bone
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!
CCommonGame
Signature
 import class CCommonGame extends CGame
Parent
 CGame
Sub-classes
 CR4Game
Version
 1.12
Path
 /game/commonGame.ws

ISerializable > IScriptable > CObject > CGame

Public Functions

AddStateChangeRequest

import final function AddStateChangeRequest(entityTag : name, modifier : IEntityStateChangeRequest)
Parameters:
entityTag : name
modifier : IEntityStateChangeRequest
Location:
starts @ line 173, ends @ line 173

AreConfigResetInThisSession

import final function AreConfigResetInThisSession() : bool
Returns:
bool
Location:
starts @ line 265, ends @ line 265

AreSavesInitialized

import final function AreSavesInitialized() : bool
Returns:
bool
Location:
starts @ line 194, ends @ line 194

AreSavesLocked

import final function AreSavesLocked() : bool
Returns:
bool
Location:
starts @ line 188, ends @ line 188

AreSubtitlesEnabled

import final function AreSubtitlesEnabled() : bool
Returns:
bool
Location:
starts @ line 9, ends @ line 9

CalculateTimePlayed

import final function CalculateTimePlayed() : GameTime
Returns:
GameTime
Location:
starts @ line 238, ends @ line 238

CanStartStandaloneDLC

import final function CanStartStandaloneDLC(dlc : name) : bool
Parameters:
dlc : name
Returns:
bool
Location:
starts @ line 83, ends @ line 83

CenterMouse

import final function CenterMouse()
Location:
starts @ line 251, ends @ line 251

ChangePlayer

import final function ChangePlayer(playerTemplate : String, optional appearance : name)
Parameters:
playerTemplate : String
optional appearance : name
Location:
starts @ line 209, ends @ line 209

CloseMenu

import final function CloseMenu(menuName : name)
Parameters:
menuName : name
Location:
starts @ line 216, ends @ line 216

ClosePopup

import final function ClosePopup(popupName : name)
Parameters:
popupName : name
Location:
starts @ line 218, ends @ line 218

ConfigSave

import final function ConfigSave()
Location:
starts @ line 191, ends @ line 191

ConvertToStrayActor

import final function ConvertToStrayActor(actor : CActor) : bool
Parameters:
actor : CActor
Returns:
bool
Location:
starts @ line 59, ends @ line 59

CreateEntityAsync

import final function CreateEntityAsync(createEntityHelper : CCreateEntityHelper, entityTemplate : CEntityTemplate, pos : Vector, optional rot : EulerAngles, optional useAppearancesFromIncludes : bool, optional forceBehaviorPose : bool, optional doNotAdjustPlacement : bool, optional persistanceMode : EPersistanceMode, optional tagList : array< name >) : int
Parameters:
createEntityHelper : CCreateEntityHelper
entityTemplate : CEntityTemplate
pos : Vector
optional rot : EulerAngles
optional useAppearancesFromIncludes : bool
optional forceBehaviorPose : bool
optional doNotAdjustPlacement : bool
optional persistanceMode : EPersistanceMode
optional tagList : array< name >
Returns:
int
Location:
starts @ line 69, ends @ line 71

CreateNoSaveLock

import final function CreateNoSaveLock(reason : string, out lock : int, optional unique : bool, optional allowCheckpoints : bool)
Parameters:
reason : string
out lock : int
optional unique : bool
optional allowCheckpoints : bool
Location:
starts @ line 179, ends @ line 179

DeleteSavedGame

import final function DeleteSavedGame(savegame : SSavegameInfo) : void
Parameters:
savegame : SSavegameInfo
Returns:
void
Location:
starts @ line 112, ends @ line 112

EnableSubtitles

import final function EnableSubtitles(enable : bool)
Parameters:
enable : bool
Location:
starts @ line 8, ends @ line 8

ForceUIAnalog

import final function ForceUIAnalog(value : bool)
Parameters:
value : bool
Location:
starts @ line 214, ends @ line 214

FreeScreenshotData

import final function FreeScreenshotData()
Location:
starts @ line 248, ends @ line 248

GetAPManager

import final function GetAPManager() : CActionPointManager
Returns:
CActionPointManager
Location:
starts @ line 138, ends @ line 138

GetAchievementsDisabled

import final function GetAchievementsDisabled() : bool
Returns:
bool
Location:
starts @ line 279, ends @ line 279

GetActorByTag

import final function GetActorByTag(tag : name) : CActor
Parameters:
tag : name
Returns:
CActor
Location:
starts @ line 144, ends @ line 144

GetActorsByTag

import final function GetActorsByTag(tag : name, out actors : array<CActor>)
Parameters:
tag : name
out actors : array<CActor>
Location:
starts @ line 148, ends @ line 148

GetAllAvailableLanguages

import final function GetAllAvailableLanguages(out textLanguages : array<string>, out speechLanguages : array<string>)
Parameters:
out textLanguages : array<string>
out speechLanguages : array<string>
Location:
starts @ line 161, ends @ line 161

GetAllNPCs

import final function GetAllNPCs(out npcs : array<CNewNPC>)
Parameters:
out npcs : array<CNewNPC>
Location:
starts @ line 135, ends @ line 135

GetApplicationVersion

import final function GetApplicationVersion() : string
Returns:
string
Location:
starts @ line 271, ends @ line 271

GetAttackRangeForEntity

import final function GetAttackRangeForEntity(sourceEntity : CEntity, optional attackName : name) : CAIAttackRange
Parameters:
sourceEntity : CEntity
optional attackName : name
Returns:
CAIAttackRange
Location:
starts @ line 15, ends @ line 15

GetBehTreeReactionManager

import final function GetBehTreeReactionManager() : CBehTreeReactionManager
Returns:
CBehTreeReactionManager
Location:
starts @ line 20, ends @ line 20

GetCommunitySystem

import final function GetCommunitySystem() : CCommunitySystem
Returns:
CCommunitySystem
Location:
starts @ line 12, ends @ line 12

GetContentRequiredByLastSave

import final function GetContentRequiredByLastSave(out content : array<name>) : void
Parameters:
out content : array<name>
Returns:
void
Location:
starts @ line 114, ends @ line 114

GetCurrentLocale

import final function GetCurrentLocale() : string
Returns:
string
Location:
starts @ line 132, ends @ line 132

GetDLCManager

import final function GetDLCManager() : CDLCManager
Returns:
CDLCManager
Location:
starts @ line 263, ends @ line 263

GetDefinitionsManager

import final function GetDefinitionsManager() : CDefinitionsManagerAccessor
Returns:
CDefinitionsManagerAccessor
Location:
starts @ line 38, ends @ line 38

GetDisplayNameForSavedGame

import final function GetDisplayNameForSavedGame(savegame : SSavegameInfo) : string
Parameters:
savegame : SSavegameInfo
Returns:
string
Location:
starts @ line 97, ends @ line 97

GetGameLanguageId

import final function GetGameLanguageId(out audioLang : int, out subtitleLang : int)
Parameters:
out audioLang : int
out subtitleLang : int
Location:
starts @ line 152, ends @ line 152

GetGameLanguageIndex

import final function GetGameLanguageIndex(out audioLang : int, out subtitleLang : int)
Parameters:
out audioLang : int
out subtitleLang : int
Location:
starts @ line 158, ends @ line 158

GetGameLanguageName

import final function GetGameLanguageName(out audioLang : string, out subtitleLang : string)
Parameters:
out audioLang : string
out subtitleLang : string
Location:
starts @ line 155, ends @ line 155

GetGameRelease

import final function GetGameRelease() : string
Returns:
string
Location:
starts @ line 129, ends @ line 129

GetGameResourceList

import final function GetGameResourceList() : array<string>
Returns:
array<string>
Location:
starts @ line 127, ends @ line 127

GetGlobalAttitude

import final function GetGlobalAttitude(srcGroup : name, dstGroup : name) : EAIAttitude
Parameters:
srcGroup : name
dstGroup : name
Returns:
EAIAttitude
Location:
starts @ line 45, ends @ line 45

GetHud

import final function GetHud() : CHud
Returns:
CHud
Location:
starts @ line 219, ends @ line 219

GetInGameConfigWrapper

import final function GetInGameConfigWrapper() : CInGameConfigWrapper
Returns:
CInGameConfigWrapper
Location:
starts @ line 220, ends @ line 220

GetIngredientCategoryElements

import final function GetIngredientCategoryElements(catName : name, out names : array<name>, out priorities : array<int>)
Parameters:
catName : name
out names : array<name>
out priorities : array<int>
Location:
starts @ line 23, ends @ line 23

GetIngredientCathegories

import final function GetIngredientCathegories() : array<name>
Returns:
array<name>
Location:
starts @ line 29, ends @ line 29

GetItemSetAbilities

import final function GetItemSetAbilities(itemName : name) : array<name>
Parameters:
itemName : name
Returns:
array<name>
Location:
starts @ line 35, ends @ line 35

GetLoadGameProgress

import final function GetLoadGameProgress() : ELoadGameResult
Returns:
ELoadGameResult
Location:
starts @ line 93, ends @ line 93

GetNPCByTag

import final function GetNPCByTag(tag : name) : CNewNPC
Parameters:
tag : name
Returns:
CNewNPC
Location:
starts @ line 145, ends @ line 145

GetNPCsByTag

import final function GetNPCsByTag(tag : name, out npcs : array<CNewNPC>)
Parameters:
tag : name
out npcs : array<CNewNPC>
Location:
starts @ line 149, ends @ line 149

GetNumSaveSlots

import final function GetNumSaveSlots(type : ESaveGameType) : int
Parameters:
type : ESaveGameType
Returns:
int
Location:
starts @ line 110, ends @ line 110

GetReactionsMgr

import final function GetReactionsMgr() : CReactionsManager
Returns:
CReactionsManager
Location:
starts @ line 18, ends @ line 18

GetReward

import final function GetReward(rewardName : name, out rewrd : SReward) : bool
Parameters:
rewardName : name
out rewrd : SReward
Returns:
bool
Location:
starts @ line 51, ends @ line 51

GetSaveInSlot

import final function GetSaveInSlot(type : ESaveGameType, slot : int, out info : SSavegameInfo) : bool
Parameters:
type : ESaveGameType
slot : int
out info : SSavegameInfo
Returns:
bool
Location:
starts @ line 120, ends @ line 120

GetSetItems

import final function GetSetItems(setName : name) : array<name>
Parameters:
setName : name
Returns:
array<name>
Location:
starts @ line 32, ends @ line 32

GetStorySceneSystem

import final function GetStorySceneSystem() : CStorySceneSystem
Returns:
CStorySceneSystem
Location:
starts @ line 141, ends @ line 141

GetUIHorizontalPlusFrameScale

import final function GetUIHorizontalPlusFrameScale() : float
Returns:
float
Location:
starts @ line 261, ends @ line 261

GiveReward

import final function GiveReward(rewardName : name, targetEntity : CEntity)
Parameters:
rewardName : name
targetEntity : CEntity
Location:
starts @ line 54, ends @ line 54

HasShownConfigChangedMessage

import final function HasShownConfigChangedMessage() : bool
Returns:
bool
Location:
starts @ line 267, ends @ line 267

HideHardwareCursor

import final function HideHardwareCursor() : void
Returns:
void
Location:
starts @ line 277, ends @ line 277

ImportSave

import final function ImportSave(savegameInfo : SSavegameInfo) : bool
Parameters:
savegameInfo : SSavegameInfo
Returns:
bool
Location:
starts @ line 223, ends @ line 223

InitStandaloneDLCLoading

import final function InitStandaloneDLCLoading(dlc : name, difficulty : int) : ELoadGameResult
Parameters:
dlc : name
difficulty : int
Returns:
ELoadGameResult
Location:
starts @ line 84, ends @ line 84

IsCameraAutoRotX

import final function IsCameraAutoRotX() : bool
Returns:
bool
Location:
starts @ line 204, ends @ line 204

IsCameraAutoRotY

import final function IsCameraAutoRotY() : bool
Returns:
bool
Location:
starts @ line 205, ends @ line 205

IsGameTimePaused

import final function IsGameTimePaused() : bool
Returns:
bool
Location:
starts @ line 169, ends @ line 169

IsIngredientCategorySpecified

import final function IsIngredientCategorySpecified(catName : name) : bool
Parameters:
catName : name
Returns:
bool
Location:
starts @ line 26, ends @ line 26

IsInvertCameraX

import final function IsInvertCameraX() : bool
Returns:
bool
Location:
starts @ line 197, ends @ line 197

IsInvertCameraY

import final function IsInvertCameraY() : bool
Returns:
bool
Location:
starts @ line 198, ends @ line 198

IsScreenshotDataReady

import final function IsScreenshotDataReady() : bool
Returns:
bool
Location:
starts @ line 245, ends @ line 245

IsSoftwareCursor

import final function IsSoftwareCursor() : bool
Returns:
bool
Location:
starts @ line 273, ends @ line 273

ListSavedGames

import final function ListSavedGames(out fileNames : array<SSavegameInfo>) : bool
Parameters:
out fileNames : array<SSavegameInfo>
Returns:
bool
Location:
starts @ line 95, ends @ line 95

ListW2SavedGames

import final function ListW2SavedGames(out savedGames : array<SSavegameInfo>) : bool
Parameters:
out savedGames : array<SSavegameInfo>
Returns:
bool
Location:
starts @ line 226, ends @ line 226

LoadGameInit

import final function LoadGameInit(info : SSavegameInfo)
Parameters:
info : SSavegameInfo
Location:
starts @ line 81, ends @ line 81

LoadLastGameInit

import final function LoadLastGameInit(optional suppressVideo : bool)
Parameters:
optional suppressVideo : bool
Location:
starts @ line 80, ends @ line 80

MoveMouseTo

import final function MoveMouseTo(xpos : float, ypos : float)
Parameters:
xpos : float
ypos : float
Location:
starts @ line 254, ends @ line 254

QueryExplorationFromObjectSync

import final function QueryExplorationFromObjectSync(entity : CEntity, object : CEntity, optional queryContext : SExplorationQueryContext) : SExplorationQueryToken
Parameters:
entity : CEntity
object : CEntity
optional queryContext : SExplorationQueryContext
Returns:
SExplorationQueryToken
Location:
starts @ line 41, ends @ line 41

QueryExplorationSync

import final function QueryExplorationSync(entity : CEntity, optional queryContext : SExplorationQueryContext) : SExplorationQueryToken
Parameters:
entity : CEntity
optional queryContext : SExplorationQueryContext
Returns:
SExplorationQueryToken
Location:
starts @ line 40, ends @ line 40

ReleaseNoSaveLock

import final function ReleaseNoSaveLock(lock : int)
Parameters:
lock : int
Location:
starts @ line 182, ends @ line 182

ReleaseNoSaveLockByName

import final function ReleaseNoSaveLockByName(lockName : string)
Parameters:
lockName : string
Location:
starts @ line 185, ends @ line 185

ReloadLanguage

import final function ReloadLanguage()
Location:
starts @ line 166, ends @ line 166

RequestAutoSave

import final function RequestAutoSave(reason : string, force : bool)
Parameters:
reason : string
force : bool
Location:
starts @ line 236, ends @ line 236

RequestEndGame

import final function RequestEndGame()
Location:
starts @ line 125, ends @ line 125

RequestExit

import final function RequestExit()
Location:
starts @ line 126, ends @ line 126

RequestMenu

import final function RequestMenu(menuName : name, optional initData : IScriptable)
Parameters:
menuName : name
optional initData : IScriptable
Location:
starts @ line 215, ends @ line 215

RequestNewGame

import final function RequestNewGame(gameResourceFilename : string) : bool
Parameters:
gameResourceFilename : string
Returns:
bool
Location:
starts @ line 124, ends @ line 124

RequestPopup

import final function RequestPopup(popupName : name, optional initData : IScriptable)
Parameters:
popupName : name
optional initData : IScriptable
Location:
starts @ line 217, ends @ line 217

RequestScreenshotData

import final function RequestScreenshotData(save : SSavegameInfo)
Parameters:
save : SSavegameInfo
Location:
starts @ line 241, ends @ line 241

SaveGame

import final function SaveGame(type : ESaveGameType, slot : int)
Parameters:
type : ESaveGameType
slot : int
Location:
starts @ line 107, ends @ line 107

ScheduleWorldChangeToMapPin

import final function ScheduleWorldChangeToMapPin(worldPath : string, mapPinName : name)
Parameters:
worldPath : string
mapPinName : name
Location:
starts @ line 211, ends @ line 211

ScheduleWorldChangeToPosition

import final function ScheduleWorldChangeToPosition(worldPath : string, position : Vector, rotation : EulerAngles)
Parameters:
worldPath : string
position : Vector
rotation : EulerAngles
Location:
starts @ line 212, ends @ line 212

SetCameraAutoRotX

import final function SetCameraAutoRotX(flag : bool)
Parameters:
flag : bool
Location:
starts @ line 206, ends @ line 206

SetCameraAutoRotY

import final function SetCameraAutoRotY(flag : bool)
Parameters:
flag : bool
Location:
starts @ line 207, ends @ line 207

SetGlobalAttitude

import final function SetGlobalAttitude(srcGroup : name, dstGroup : name, attitude : EAIAttitude) : bool
Parameters:
srcGroup : name
dstGroup : name
attitude : EAIAttitude
Returns:
bool
Location:
starts @ line 48, ends @ line 48

SetHasShownConfigChangedMessage

import final function SetHasShownConfigChangedMessage(value : bool) : void
Parameters:
value : bool
Returns:
void
Location:
starts @ line 269, ends @ line 269

SetInvertCameraX

import final function SetInvertCameraX(invert : bool)
Parameters:
invert : bool
Location:
starts @ line 199, ends @ line 199

SetInvertCameraXOnMouse

import final function SetInvertCameraXOnMouse(invert : bool)
Parameters:
invert : bool
Location:
starts @ line 201, ends @ line 201

SetInvertCameraY

import final function SetInvertCameraY(invert : bool)
Parameters:
invert : bool
Location:
starts @ line 200, ends @ line 200

SetInvertCameraYOnMouse

import final function SetInvertCameraYOnMouse(invert : bool)
Parameters:
invert : bool
Location:
starts @ line 202, ends @ line 202

ShouldShowSaveCompatibilityWarning

import final function ShouldShowSaveCompatibilityWarning() : bool
Returns:
bool
Location:
starts @ line 122, ends @ line 122

ShowHardwareCursor

import final function ShowHardwareCursor() : void
Returns:
void
Location:
starts @ line 275, ends @ line 275

SwitchGameLanguageByIndex

import final function SwitchGameLanguageByIndex(audioLang : int, subtitleLang : int)
Parameters:
audioLang : int
subtitleLang : int
Location:
starts @ line 164, ends @ line 164

TestNoCreaturesOnLine

import final function TestNoCreaturesOnLine(pos0 : Vector, pos1 : Vector, lineWidth : float, optional ignoreActor0 : CActor, optional ignoreActor1 : CActor, optional ignoreGhostCharacters : bool) : bool
Parameters:
pos0 : Vector
pos1 : Vector
lineWidth : float
optional ignoreActor0 : CActor
optional ignoreActor1 : CActor
optional ignoreGhostCharacters : bool
Returns:
bool
Location:
starts @ line 232, ends @ line 232

TestNoCreaturesOnLocation

import final function TestNoCreaturesOnLocation(pos : Vector, radius : float, optional ignoreActor : CActor) : bool
Parameters:
pos : Vector
radius : float
optional ignoreActor : CActor
Returns:
bool
Location:
starts @ line 229, ends @ line 229

Public Vars

tooltipSettings

public var tooltipSettings : C2dArray
Location:
defined @ line 259

Event Handlers

OnBeforeWorldChange

event OnBeforeWorldChange(worldName : string)
Parameters:
worldName : string
Location:
starts @ line 256
Community content is available under CC BY-SA 3.0 unless otherwise noted.
More Fandoms

Fan Feed

More Witcher Wiki