Interface IPlotPointAction

IPlotPointFrameDatas contain a series of Plot Point Actions which can perform various animation and logical operations

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public interface IPlotPointAction

Properties

Data

The IPlotPointActionData that this action uses to populate it's variables

Declaration

IPlotPointActionData Data { get; }

Property Value

Type	Description
IPlotPointActionData

Name

A human readable name for the action

Declaration

string Name { get; }

Property Value

Type	Description
String

Progress

The current progress of the Plot Point Action between 0 and 1

Declaration

float Progress { get; }

Property Value

Type	Description
Single

State

The current state of the Plot Point Action

Declaration

PlotPointActionState State { get; }

Property Value

Type	Description
PlotPointActionState

Methods

Execute(Action<IPlotPointAction>)

Execute the Plot Point Action

Declaration

void Execute(Action<IPlotPointAction> onComplete)

Parameters

Type	Name	Description
Action<IPlotPointAction>	onComplete	An action which will be fired once the action completes naturally

Initialize(IPlotPointController, IUnityEventListener, IPlotPointActionData)

Initialize the Plot Point Action Note: This could be called multiple times depending on implementation

Declaration

void Initialize(IPlotPointController controller, IUnityEventListener unityEventListener, IPlotPointActionData data)

Parameters

Type	Name	Description
IPlotPointController	controller	The IPlotPointController that will be activating the action
IUnityEventListener	unityEventListener	The IUnityEventListener that will control the action's update loop
IPlotPointActionData	data	The IPlotPointActionData which will provide the action with it's parameters

Reset()

Resets the state of the Plot Point Action, all Actions should be fully reversible

Declaration

void Reset()

Skip()

Skips the Plot Point Action to it's final state, all Actions should be fully skippable

Declaration

void Skip()