Class vCast.Cmd
The highest level functions in IO system, to handle commands.
輸入輸出系統中的最高級別的功能，用作處理指令。
Inheritance
Namespace: Votanic.vXR.vCast
Assembly: Votanic.vXR.dll
Syntax
public class CmdMethods
AllReceived()
Return all received commands of current frame.
傳回當前幀所有已接收的指令。
Declaration
public static List<string> AllReceived()Returns
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.String> |
Command(String)
Return the original command string.
當指令處理器收到指令時傳回原指令字串。
Command("HelloWorld")
Declaration
public static string Command(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
Returns
| Type | Description |
|---|---|
| System.String |
Context()
Get the context mode of command system.
取得指令系統的景況模式。
Declaration
public static int Context()Returns
| Type | Description |
|---|---|
| System.Int32 |
Context(Int32)
Set the context mode of command system.
設定指令系統的景況模式。
Context(0)
Declaration
public static void Context(int mode = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | mode | Mode index |
Interactor(String)
Return the interactor index if the command handler received a command.
當指令處理器收到指令時傳回交互器編號。
Interactor("HelloWorld")
Declaration
public static int Interactor(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Received(String)
Return true if the command handler received a command.
當指令處理器收到指令時傳回 true。
Received("HelloWorld")
Declaration
public static bool Received(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Send(String, Single, Int32, Int32, InteractorType)
Send a command to the command handler.
傳送指令至指令處理器。
Send("HelloWorld")
Declaration
public static void Send(string command, float value = 1F, int target = -1, int interactor = -1, InteractorType type = InteractorType.None)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
| System.Single | value | The floating value of the executable command |
| System.Int32 | target | Target object index for the command |
| System.Int32 | interactor | The interactor index for sending the command |
| InteractorType | type | The interactor type for sending the command |
Target(String)
Return the target object index if the command handler received a command.
當指令處理器收到指令時傳回目標物編號。
Target("HelloWorld")
Declaration
public static int Target(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
Returns
| Type | Description |
|---|---|
| System.Int32 |
Type(String)
Return the interactor type if the command handler received a command.
當指令處理器收到指令時傳回交互器類型。
Type("HelloWorld")
Declaration
public static InteractorType Type(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
Returns
| Type | Description |
|---|---|
| InteractorType |
Value(String)
Return the floating value if the command handler received a command.
當指令處理器收到指令時傳回浮點值。
Value("HelloWorld")
Declaration
public static float Value(string command)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | command | Target command |
Returns
| Type | Description |
|---|---|
| System.Single |