Cyber Engine Tweaks
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(deviceID : EntityID) : ref:GameObject;

GetExtendedInfo

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

GetIdOfExitAnim

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

HardResetPlaybackToStart

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

HasExitNodes

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

IsActorInWorkspot

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

IsInVehicleWorkspot

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

IsReactionAvailable

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

MountToVehicle

MountToVehicle
Info & Usage
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;

PlayInDevice

PlayInDevice
Info & Usage
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;

PlayInDeviceSimple

PlayInDeviceSimple
Info & Usage
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;

PlayNpcInWorkspot

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

ResetPlaybackToStart

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

SendAdjustAndPlaySignal

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

SendDebugCommand

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

SendDebugCommandEnt

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

SendDebugCommandFunctionalTests

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

SendDynamicSyncBindSignal

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

SendDynamicSyncUnbindSignal

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

SendEventToConnectedSpots

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

SendFastExitSignal

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

SendForwardSignal

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

SendJumpCommandEnt

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

SendJumpToAnimEnt

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

SendJumpToTagCommandEnt

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

SendPlaySignal

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

SendReactionSignal

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

SendSlowExitSignal

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

StopInDevice

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

StopNpcInWorkspot

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

SwitchSeatVehicle

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

UnmountFromVehicle

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