Struct TimerTask
The timer task returns a running status for a specified amount of time in seconds and a success status afterwards.
Namespace: Unity.Kinematica
Syntax
[Data("Timer", "#2A3756", DataType.Flag.None)]
public struct TimerTask : Task, GenericTask<TimerTask>
Properties
self
Declaration
public Identifier<TimerTask> self { get; set; }
Property Value
| Type | Description |
|---|---|
| Identifier<TimerTask> |
Implements
Methods
Execute()
Execute method for the timer task.
Declaration
public Result Execute()
Returns
| Type | Description |
|---|---|
| Result | Returns running for the duration of the specified time; success upon completion. |
Implements
Remarks
The timer task returns a running status for a specified amount of time in seconds and a success status afterwards.
ExecuteSelf(ref TaskPointer)
Surrogate method for automatic task execution.
Declaration
public static Result ExecuteSelf(ref TaskPointer self)
Parameters
| Type | Name | Description |
|---|---|---|
| TaskPointer | self | Task reference that is supposed to be executed. |
Returns
| Type | Description |
|---|---|
| Result | Result of the task execution. |