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

GetDeviceUser(deviceID : EntityID) : ref:GameObject;

Info & Usage

GetExtendedInfo

GetExtendedInfo

GetExtendedInfo(actor : ref:GameObject) : ref:ExtendedWorkspotInfo;

Info & Usage

GetIdOfExitAnim

GetIdOfExitAnim

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

Info & Usage

HardResetPlaybackToStart

HardResetPlaybackToStart

HardResetPlaybackToStart(actor : ref:GameObject);

Info & Usage

HasExitNodes

HasExitNodes

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

Info & Usage

IsActorInWorkspot

IsActorInWorkspot

IsActorInWorkspot(actor : ref:GameObject) : Bool;

Info & Usage

IsInVehicleWorkspot

IsInVehicleWorkspot

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

Info & Usage

IsReactionAvailable

IsReactionAvailable

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

Info & Usage

MountToVehicle

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

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

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

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

ResetPlaybackToStart(actor : ref:GameObject);

Info & Usage

SendAdjustAndPlaySignal

SendAdjustAndPlaySignal

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

Info & Usage

SendDebugCommand

SendDebugCommand

SendDebugCommand(mode : workWorkspotDebugMode, entId : String);

Info & Usage

SendDebugCommandEnt

SendDebugCommandEnt

SendDebugCommandEnt(mode : workWorkspotDebugMode, obj : ref:GameObject);

Info & Usage

SendDebugCommandFunctionalTests

SendDebugCommandFunctionalTests

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

Info & Usage

SendDynamicSyncBindSignal

SendDynamicSyncBindSignal

SendDynamicSyncBindSignal(actor : ref:GameObject, master : ref:GameObject);

Info & Usage

SendDynamicSyncUnbindSignal

SendDynamicSyncUnbindSignal

SendDynamicSyncUnbindSignal(actor : ref:GameObject);

Info & Usage

SendEventToConnectedSpots

SendEventToConnectedSpots

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

Info & Usage

SendFastExitSignal

SendFastExitSignal

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

Info & Usage

SendForwardSignal

SendForwardSignal

SendForwardSignal(actor : ref:GameObject);

Info & Usage

SendJumpCommandEnt

SendJumpCommandEnt

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

Info & Usage

SendJumpToAnimEnt

SendJumpToAnimEnt

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

Info & Usage

SendJumpToTagCommandEnt

SendJumpToTagCommandEnt

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

Info & Usage

SendPlaySignal

SendPlaySignal

SendPlaySignal(actor : ref:GameObject);

Info & Usage

SendReactionSignal

SendReactionSignal

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

Info & Usage

SendSlowExitSignal

SendSlowExitSignal

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

Info & Usage

StopInDevice

StopInDevice

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

Info & Usage

StopNpcInWorkspot

StopNpcInWorkspot

StopNpcInWorkspot(actor : ref:GameObject);

Info & Usage

SwitchSeatVehicle

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

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

Info & Usage