Class ScenarioTabHandler

A tab handler for scenarios. This class is necessary because VisualElements cannot be serialized.

Inheritance
object
Object
ScriptableObject
ScenarioTabHandler
Implements
Namespace: Xareus.Scenarios.Unity.Edition
Assembly: Xareus.Scenarios.Unity.Edition.dll
Syntax
[Serializable]
public class ScenarioTabHandler : ScriptableObject, IToolbarEntryData, IScenarioEventHandler

Fields

Played

Declaration
[SerializeField]
public bool Played
Field Value
Type Description
bool

Properties

ButtonText

Declaration
public string ButtonText { get; }
Property Value
Type Description
string

Canvas

Declaration
public CanvasUI Canvas { get; }
Property Value
Type Description
CanvasUI

IsPlaying

Declaration
public bool IsPlaying { get; set; }
Property Value
Type Description
bool

LayerIds

Declaration
public List<string> LayerIds { get; }
Property Value
Type Description
List<string>

Position

Access to the canvas offset (Relative to the virtual space point of reference)

Declaration
public Vector2 Position { get; set; }
Property Value
Type Description
Vector2

ScenarioId

Declaration
public string ScenarioId { get; }
Property Value
Type Description
string

ScenarioWrapper

Declaration
public ScenarioWrapper ScenarioWrapper { get; set; }
Property Value
Type Description
ScenarioWrapper

Tab

Declaration
public Tab Tab { get; }
Property Value
Type Description
Tab

Zoom

Access to the canvas zoom

Declaration
public float Zoom { get; set; }
Property Value
Type Description
float

Methods

BeforeStopPlaying()

Declaration
public void BeforeStopPlaying()

HandleEvent(EventBase, Identifiable)

Declaration
public void HandleEvent(EventBase e, Identifiable source)
Parameters
Type Name Description
EventBase e
Identifiable source

Init(Scenario, string, SequenceType)

Declaration
public void Init(Scenario scenario, string scenarioFilePath = "", SequenceType sequenceType = SequenceType.PetriNet)
Parameters
Type Name Description
Scenario scenario
string scenarioFilePath
SequenceType sequenceType

OnDestroy()

OnDestroy is called when the tab is closed, but not on domain reload (entering/quitting playmode) or recompilation

Declaration
public void OnDestroy()

OnEnable()

Declaration
public void OnEnable()

Reload()

Declaration
public void Reload()

StopPlaying()

Declaration
public void StopPlaying()

Implements