Command Action and Data
CommandAction Enum
Specifies a command action.
Syntax
[Sansar.Script.Interface] [System.Flags] public enum CommandAction
Remarks
Members
Member Name | Description |
---|---|
All | A combination of all other values. |
Invalid | An invalid command action. |
Pressed | Fired when the command is pressed. |
Released | Fired when the command is released. |
Requirements
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
CommandData
CommandData Class
Command events are generated by the client when input events occur.
Syntax
Remarks
Command | Default Key Binding |
---|---|
Trigger | Left Mouse Button |
PrimaryAction | F |
SecondaryAction | R |
Modifier | Shift |
Action1 to Action0 | Number keys 1 to 0 |
Confirm | Enter |
Cancel | Escape |
SelectLeft | Left arrow |
SelectRight | Right arrow |
SelectUp | Up arrow |
SelectDown | Down arrow |
Keypad0 to Keypad9 | Numberpad keys 0 to 9 |
KeypadEnter | Numberpad Enter |
An example script for handling client commands:
C# Example |
Requirements
Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Members
Member Details
Action Property
The action which occurred.
Syntax[get: Sansar.Script.Interface] public CommandAction Action { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
CameraControlMode Property
Syntax[get: Sansar.Script.Interface] public CameraControlMode CameraControlMode { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Command Property
The command which occurred.
Syntax[get: Sansar.Script.Interface] public string Command { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
ControlPoint Property
Syntax[get: Sansar.Script.Interface] public ControlPointType ControlPoint { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
MouseLookMode Property
Syntax[get: Sansar.Script.Interface] public bool MouseLookMode { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SessionId Property
The client which generated the event.
SyntaxValue
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
SimulationFrame Property
Syntax[get: Sansar.Script.Interface] public ulong SimulationFrame { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
TargetingComponent Property
SyntaxValue
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
TargetingNormal Property
Syntax[get: Sansar.Script.Interface] public Sansar.Vector TargetingNormal { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
TargetingOrigin Property
Syntax[get: Sansar.Script.Interface] public Sansar.Vector TargetingOrigin { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
TargetingPosition Property
Syntax[get: Sansar.Script.Interface] public Sansar.Vector TargetingPosition { get; }
Value
Remarks
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
ToString Method
A string representation of this object.
Syntax[Sansar.Script.Interface] public override string ToString ()
Returns
A string representation of this object.
RemarksThe format of this string may change between releases.
RequirementsNamespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0
Last updated