CodeInstruction Class

Definition

An instruction with a code callback.

C#

public class CodeInstruction : InstructionBase, IComponent

Inheritance object → UpdateComponent → InstructionBase

Implements IComponent

Constructors

CodeInstruction(Func<IScreenObject, TimeSpan, bool>)

Creates a new instruction with the specified callback.

C#

public CodeInstruction(Func<IScreenObject, TimeSpan, bool> callback)

Parameters

callback Func<IScreenObject, TimeSpan, bool>
The code invoked by this instruction. Return true to set IsFinished.

Properties

ID

Friendly ID to help track what this code instruction was created from since it cannot be fully serialized.

C#

public string ID { get; set; }

Methods

Update(IScreenObject, TimeSpan)

Executes the instruction. This base class method should be called from derived classes. If the IsFinished property is set to true, will try to repeat if needed and will raise all appropriate events.

C#

public override void Update(IScreenObject componentHost, TimeSpan delta)

Parameters

componentHost IScreenObject
The object that hosts this instruction.

delta TimeSpan
The time that has elapsed since this method was last called.

SetCallback(Func<IScreenObject, TimeSpan, bool>)

Sets the callback used by the instruction.

C#

public void SetCallback(Func<IScreenObject, TimeSpan, bool> callback)

Parameters

callback Func<IScreenObject, TimeSpan, bool>
The code invoked by this instruction. Return true to set IsFinished.