Choices List

📝 ChoicesList Class

Displays choices that the player can select for choice nodes.

Namespace: Esper.FeelSpeak.UI Inherits from: MonoBehaviour Type: abstract class


📦 Fields

Access
Field
Type
Description

public

dontDestroyOnLoad

bool

If this object should not be destroyed when the scene is unloaded.

public

choiceNode

ChoiceNode

The choice node that choices are being displayed for.

public

onOpen

UnityEvent

A callback for when the choices list is opened.

public

onClose

UnityEvent

A callback for when the choices list is closed.

public

onChoiceSelected

UnityEvent<Choice>

A callback for when a choice is selected. This accepts 1 argument: the choice (Choice).


🔧 Properties

Access
Property
Type
Description

public abstract

IsOpen

bool

If the choices list is open.

public static

Instance

ChoicesList

The active instance.


🧰 Methods

Access
Method
Returns
Description

protected virtual

Awake()

void

Virtual method for Unity Awake lifecycle.

public abstract

Hide()

void

Abstract method to hide the choices.

public abstract

Show()

void

Abstract method to show the choices.

public abstract

MakeChoice(Choice)

void

Abstract method to make the choice. This will briefly mark the choice made.

public abstract

Clear()

void

Abstract method to remove all choices.

public virtual

Open(ChoiceNode)

void

Virtual method to open the choices list and display choices based on the choice node.

public virtual

Close()

void

Virtual method to close the choices list.

public abstract

RefreshList()

void

Abstract method to refresh the choices list.

public

OnOptionSelected(Choice)

void

Handles a choice option selection.

Last updated