Modding
Dictionary
Other
External docs
Other Wikis

WorkspotGameSystem

Documents the WorkspotGameSystem class and its functions.

fsafasf

NOT DOCUMENTED We currently don't have information on how these functions work. They are being documented here for visibility.

Invoking WorkspotGameSystem

To invoke the workspot game system, use the following Global function:

wgs = Game.GetWorkspotSystem()

Sub-functions

GetDeviceUser

GetDeviceUser
Info & Usage
GetDeviceUser
GetDeviceUser(deviceID : EntityID) : ref:GameObject;
Info & Usage

GetExtendedInfo

GetExtendedInfo
Info & Usage
GetExtendedInfo
GetExtendedInfo(actor : ref:GameObject) : ref:ExtendedWorkspotInfo;
Info & Usage

GetIdOfExitAnim

GetIdOfExitAnim
Info & Usage
GetIdOfExitAnim
GetIdOfExitAnim(actor : ref:GameObject, animName : CName) : Int32;
Info & Usage

HardResetPlaybackToStart

HardResetPlaybackToStart
Info & Usage
HardResetPlaybackToStart
HardResetPlaybackToStart(actor : ref:GameObject);
Info & Usage

HasExitNodes

HasExitNodes
Info & Usage
HasExitNodes
HasExitNodes(actor : ref:GameObject, fastExit : Bool, slowExit : Bool, optional performNavmeshChecks : Bool) : Bool;
Info & Usage

IsActorInWorkspot

IsActorInWorkspot
Info & Usage
IsActorInWorkspot
IsActorInWorkspot(actor : ref:GameObject) : Bool;
Info & Usage

IsInVehicleWorkspot

IsInVehicleWorkspot
Info & Usage
IsInVehicleWorkspot
IsInVehicleWorkspot(vehicle : ref:GameObject, child : ref:GameObject, slotName : CName) : Bool;
Info & Usage

IsReactionAvailable

IsReactionAvailable
Info & Usage
IsReactionAvailable
IsReactionAvailable(actor : ref:GameObject, reactionName : CName) : Bool;
Info & Usage

MountToVehicle

MountToVehicle
Info & Usage
MountToVehicle
MountToVehicle(parent : ref:GameObject, child : ref:GameObject, slideTime : Float, animDelay : Float, workspotResourceContainer : CName, slotName : CName, optional syncronizedObjects : array:EntityID, optional entrySlotName : CName, optional animVariables : array:CName) : Bool;
Info & Usage

PlayInDevice

PlayInDevice
Info & Usage
PlayInDevice
PlayInDevice(device : ref:GameObject, actor : ref:GameObject, optional workspotStateFlavourName : CName, optional actorDataCompName : CName, optional deviceDataCompName : CName, optional syncSlotName : CName, optional slideTime : Float, optional slideBehaviour : WorkspotSlidingBehaviour) : Bool;
Info & Usage

PlayInDeviceSimple

PlayInDeviceSimple
Info & Usage
PlayInDeviceSimple
PlayInDeviceSimple(device : ref:GameObject, actor : ref:GameObject, allowCameraMov : Bool, optional actorDataCompName : CName, optional deviceDataCompName : CName, optional syncSlotName : CName, optional slideTime : Float, optional slideBehaviour : WorkspotSlidingBehaviour) : Bool;
Info & Usage

PlayNpcInWorkspot

PlayNpcInWorkspot
Info & Usage
PlayNpcInWorkspot
PlayNpcInWorkspot(npc : ref:GameObject, master : ref:GameObject, referenceEntity : ref:GameObject, actorDataCompName : CName, optional syncSlotName : CName, optional slideTime : Float, optional syncOffsetSourceCompName : CName);
Info & Usage

ResetPlaybackToStart

ResetPlaybackToStart
Info & Usage
ResetPlaybackToStart
ResetPlaybackToStart(actor : ref:GameObject);
Info & Usage

SendAdjustAndPlaySignal

SendAdjustAndPlaySignal
Info & Usage
SendAdjustAndPlaySignal
SendAdjustAndPlaySignal(actor : ref:GameObject, adjustTime : Float, playbackDelay : Float, adjustDelta : Transform);
Info & Usage

SendDebugCommand

SendDebugCommand
Info & Usage
SendDebugCommand
SendDebugCommand(mode : workWorkspotDebugMode, entId : String);
Info & Usage

SendDebugCommandEnt

SendDebugCommandEnt
Info & Usage
SendDebugCommandEnt
SendDebugCommandEnt(mode : workWorkspotDebugMode, obj : ref:GameObject);
Info & Usage

SendDebugCommandFunctionalTests

SendDebugCommandFunctionalTests
Info & Usage
SendDebugCommandFunctionalTests
SendDebugCommandFunctionalTests(mode : workWorkspotDebugMode, obj : ref:GameObject, redscript : ref:IScriptable);
Info & Usage

SendDynamicSyncBindSignal

SendDynamicSyncBindSignal
Info & Usage
SendDynamicSyncBindSignal
SendDynamicSyncBindSignal(actor : ref:GameObject, master : ref:GameObject);
Info & Usage

SendDynamicSyncUnbindSignal

SendDynamicSyncUnbindSignal
Info & Usage
SendDynamicSyncUnbindSignal
SendDynamicSyncUnbindSignal(actor : ref:GameObject);
Info & Usage

SendEventToConnectedSpots

SendEventToConnectedSpots
Info & Usage
SendEventToConnectedSpots
SendEventToConnectedSpots(actor : ref:GameObject, eventName : CName) : Bool;
Info & Usage

SendFastExitSignal

SendFastExitSignal
Info & Usage
SendFastExitSignal
SendFastExitSignal(actor : ref:GameObject, optional dirLS : Vector3, optional stayInWorkspotIfFailed : Bool, optional playSlowExitIfFailed : Bool, optional instant : Bool, optional tryBlendToWalk : Bool);
Info & Usage

SendForwardSignal

SendForwardSignal
Info & Usage
SendForwardSignal
SendForwardSignal(actor : ref:GameObject);
Info & Usage

SendJumpCommandEnt

SendJumpCommandEnt
Info & Usage
SendJumpCommandEnt
SendJumpCommandEnt(actor : ref:GameObject, entryId : Int32, instant : Bool);
Info & Usage

SendJumpToAnimEnt

SendJumpToAnimEnt
Info & Usage
SendJumpToAnimEnt
SendJumpToAnimEnt(actor : ref:GameObject, animName : CName, instant : Bool);
Info & Usage

SendJumpToTagCommandEnt

SendJumpToTagCommandEnt
Info & Usage
SendJumpToTagCommandEnt
SendJumpToTagCommandEnt(actor : ref:GameObject, entryTag : CName, instant : Bool);
Info & Usage

SendPlaySignal

SendPlaySignal
Info & Usage
SendPlaySignal
SendPlaySignal(actor : ref:GameObject);
Info & Usage

SendReactionSignal

SendReactionSignal
Info & Usage
SendReactionSignal
SendReactionSignal(actor : ref:GameObject, reactionName : CName) : Bool;
Info & Usage

SendSlowExitSignal

SendSlowExitSignal
Info & Usage
SendSlowExitSignal
SendSlowExitSignal(actor : ref:GameObject, optional animationName : CName, optional dontWaitForCurrentAnimationToFinish : Bool);
Info & Usage

StopInDevice

StopInDevice
Info & Usage
StopInDevice
StopInDevice(actor : ref:GameObject, optional posDelta : Vector4, optional orientDelta : Quaternion);
Info & Usage

StopNpcInWorkspot

StopNpcInWorkspot
Info & Usage
StopNpcInWorkspot
StopNpcInWorkspot(actor : ref:GameObject);
Info & Usage

SwitchSeatVehicle

SwitchSeatVehicle
Info & Usage
SwitchSeatVehicle
SwitchSeatVehicle(parent : ref:GameObject, child : ref:GameObject, workspotResourceContainer : CName, slotName : CName, optional exitSlotName : CName, optional activateAnimVariables : array:CName, optional deactivateAnimVariables : array:CName);
Info & Usage

UnmountFromVehicle

UnmountFromVehicle
Info & Usage
UnmountFromVehicle
UnmountFromVehicle(parent : ref:GameObject, child : ref:GameObject, optional instant : Bool, optional posDelta : Vector4, optional orientDelta : Quaternion, optional exitSlotName : CName);
Info & Usage