Class BasePlotPointController

Inheritance

Object

BasePlotPointController

PlotPointController

Implements

IPlotPointController

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public abstract class BasePlotPointController : MonoBehaviour, IPlotPointController

Fields

_actions

Declaration

protected IPlotPointAction[][] _actions

Field Value

Type	Description
IPlotPointAction[][]

_activeSequence

Declaration

protected IPlotPointSequenceData _activeSequence

Field Value

Type	Description
IPlotPointSequenceData

_actorPool

Declaration

protected readonly PlotPointActorPool _actorPool

Field Value

Type	Description
PlotPointActorPool

_actorRoot

Declaration

protected RectTransform _actorRoot

Field Value

Type	Description
RectTransform

_continueButton

Declaration

protected Button _continueButton

Field Value

Type	Description
Button

_currentActionIndex

Declaration

protected int _currentActionIndex

Field Value

Type	Description
Int32

_currentFrameIndex

Declaration

protected int _currentFrameIndex

Field Value

Type	Description
Int32

_frames

Declaration

protected IPlotPointFrameData[] _frames

Field Value

Type	Description
IPlotPointFrameData[]

_imageActor

Declaration

protected PlotPointImageActor _imageActor

Field Value

Type	Description
PlotPointImageActor

_panContainer

Declaration

protected RectTransform _panContainer

Field Value

Type	Description
RectTransform

_plotPointDataProvider

Declaration

protected IPlotPointDataProvider _plotPointDataProvider

Field Value

Type	Description
IPlotPointDataProvider

_sceneryPool

Declaration

protected readonly Dictionary<string, GameObject> _sceneryPool

Field Value

Type	Description
Dictionary<String, GameObject>

_sceneryRoot

Declaration

protected RectTransform _sceneryRoot

Field Value

Type	Description
RectTransform

_speechBubbleActor

Declaration

protected PlotPointSpeechBubbleActor _speechBubbleActor

Field Value

Type	Description
PlotPointSpeechBubbleActor

_textActor

Declaration

protected PlotPointTextActor _textActor

Field Value

Type	Description
PlotPointTextActor

_unityEventListener

Declaration

protected IUnityEventListener _unityEventListener

Field Value

Type	Description
IUnityEventListener

Properties

Actions

Declaration

public virtual IPlotPointAction[][] Actions { get; }

Property Value

Type	Description
IPlotPointAction[][]

ActiveSequence

Declaration

public virtual IPlotPointSequenceData ActiveSequence { get; }

Property Value

Type	Description
IPlotPointSequenceData

CurrentFrameIndex

Declaration

public virtual int CurrentFrameIndex { get; }

Property Value

Type	Description
Int32

Frames

Declaration

public virtual IPlotPointFrameData[] Frames { get; }

Property Value

Type	Description
IPlotPointFrameData[]

IsPlaying

Declaration

public abstract bool IsPlaying { get; }

Property Value

Type	Description
Boolean

PanContainer

Declaration

public virtual RectTransform PanContainer { get; }

Property Value

Type	Description
RectTransform

Methods

Cleanup()

Declaration

public virtual void Cleanup()

ExecuteAction(Int32)

Executes the IPlotPointAction at a given actionIndex on the current IPlotPointFrameData

Declaration

protected virtual void ExecuteAction(int actionIndex)

Parameters

Type	Name	Description
Int32	actionIndex

ExecuteNextAction(IPlotPointAction)

Executes the next IPlotPointAction in the current IPlotPointFrameData.

Declaration

protected virtual void ExecuteNextAction(IPlotPointAction previousAction)

Parameters

Type	Name	Description
IPlotPointAction	previousAction

HandleContinueButtonClick()

Responds to user input on a continue button. Skips all remaining actions or progresses to the next frame depending on the state of the action queue

Declaration

protected virtual void HandleContinueButtonClick()

HandleFramePlayed(IPlotPointFrameData, Int32)

Declaration

protected void HandleFramePlayed(IPlotPointFrameData frameData, int index)

Parameters

Type	Name	Description
IPlotPointFrameData	frameData
Int32	index

HandleFrameSet(Int32)

Declaration

protected void HandleFrameSet(int index)

Parameters

Type	Name	Description
Int32	index

HandleSequenceCompleted(IPlotPointSequenceData)

Declaration

protected void HandleSequenceCompleted(IPlotPointSequenceData sequenceData)

Parameters

Type	Name	Description
IPlotPointSequenceData	sequenceData

HandleSequenceEnded(IPlotPointSequenceData)

Declaration

protected void HandleSequenceEnded(IPlotPointSequenceData sequenceData)

Parameters

Type	Name	Description
IPlotPointSequenceData	sequenceData

HandleSequenceLoaded(IPlotPointSequenceData)

Declaration

protected void HandleSequenceLoaded(IPlotPointSequenceData sequenceData)

Parameters

Type	Name	Description
IPlotPointSequenceData	sequenceData

HandleSequenceQueued(IPlotPointSequenceData)

Declaration

protected void HandleSequenceQueued(IPlotPointSequenceData sequenceData)

Parameters

Type	Name	Description
IPlotPointSequenceData	sequenceData

HandleSequenceStarted(IPlotPointSequenceData)

Declaration

protected void HandleSequenceStarted(IPlotPointSequenceData sequenceData)

Parameters

Type	Name	Description
IPlotPointSequenceData	sequenceData

LoadActions(IPlotPointFrameData[])

Loads all relevant actions for the given series of frames

Declaration

protected virtual void LoadActions(IPlotPointFrameData[] frames)

Parameters

Type	Name	Description
IPlotPointFrameData[]	frames

LoadFrames(IPlotPointSequenceData)

Loads all relevant frames for the given sequence

Declaration

protected virtual void LoadFrames(IPlotPointSequenceData sequence)

Parameters

Type	Name	Description
IPlotPointSequenceData	sequence

LoadSequence(IPlotPointSequenceData, Int32)

Set's the current IPlotPointSequenceData and the frame to start on

Declaration

public virtual void LoadSequence(IPlotPointSequenceData newSequence, int frameIndex)

Parameters

Type	Name	Description
IPlotPointSequenceData	newSequence
Int32	frameIndex

Pause()

Declaration

public abstract void Pause()

Play(IPlotPointSequenceData)

Declaration

public abstract void Play(IPlotPointSequenceData plotPointSequenceData = null)

Parameters

Type	Name	Description
IPlotPointSequenceData	plotPointSequenceData

ReleaseActors()

Releases all current IPlotPointActors into the PlotPointActorPool

Declaration

protected virtual void ReleaseActors()

ResetActions(Int32)

Iterates backwards from the current frame to a given frame undoing any completed IPlotPointActions

Declaration

protected virtual void ResetActions(int frameIndex)

Parameters

Type	Name	Description
Int32	frameIndex

ResetPlayer()

Declaration

protected virtual void ResetPlayer()

Resume()

Declaration

public abstract void Resume()

SetActors(IPlotPointActorData[])

Sets up a series of IPlotPointActors based on an array of IPlotPointActorData

Declaration

protected virtual void SetActors(IPlotPointActorData[] actorData)

Parameters

Type	Name	Description
IPlotPointActorData[]	actorData

SetFrameIndex(Int32)

Sets the current IPlotPointFrameData and skips or resets and necessary actions

Declaration

public virtual void SetFrameIndex(int frameIndex)

Parameters

Type	Name	Description
Int32	frameIndex

SetPanPosition(Vector2)

Set's the position of the PanContainer to a given UnityEngine.Vector2

Declaration

protected virtual void SetPanPosition(Vector2 panPosition)

Parameters

Type	Name	Description
Vector2	panPosition

SetScenery(GameObject)

Adds a given scenery prefab to the scenery root or activates it if the prefab already exists

Declaration

protected virtual void SetScenery(GameObject sceneryPrefab)

Parameters

Type	Name	Description
GameObject	sceneryPrefab

SkipActions(Int32)

Iterates forwards from the current frame to a given frame skipping any incomplete IPlotPointActions

Declaration

protected virtual void SkipActions(int frameIndex)

Parameters

Type	Name	Description
Int32	frameIndex

Start()

Declaration

protected virtual void Start()

Stop()

Declaration

public abstract void Stop()

Events

OnFramePlayed

Declaration

public event FramePlayedHandler OnFramePlayed

Event Type

Type	Description
FramePlayedHandler

OnFrameSet

Declaration

public event FrameSetHandler OnFrameSet

Event Type

Type	Description
FrameSetHandler

OnSequenceCompleted

Declaration

public event SequenceCompletedHandler OnSequenceCompleted

Event Type

Type	Description
SequenceCompletedHandler

OnSequenceEnded

Declaration

public event SequenceEndedHandler OnSequenceEnded

Event Type

Type	Description
SequenceEndedHandler

OnSequenceLoaded

Declaration

public event SequenceLoadedHandler OnSequenceLoaded

Event Type

Type	Description
SequenceLoadedHandler

OnSequenceQueued

Declaration

public event SequenceQueuedHandler OnSequenceQueued

Event Type

Type	Description
SequenceQueuedHandler

OnSequenceStarted

Declaration

public event SequenceStartedHandler OnSequenceStarted

Event Type

Type	Description
SequenceStartedHandler

Implements

IPlotPointController