caleb-brown/unity-atoms
1
0
Fork 0
mirror of https://github.com/unity-atoms/unity-atoms.git synced 2025-01-22 08:08:51 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
bc2a68527f
unity-atoms/docs/api/unityatoms.scenemgmt.md
Miika Lönnqvist 3b39e6a2f1
Prepare for release of 4.4.4 (#343) 
* Update CHANGELOG

* Update version in documentation to 4.4.4

* Remove reference to Examples directory

* Update package-lock.json

* Update API documentation
2022-04-17 22:52:38 +02:00

5.6 KiB
Raw Blame History

id title hide_title sidebar_label
unityatoms.scenemgmt UnityAtoms.SceneMgmt true UnityAtoms.SceneMgmt

Namespace - UnityAtoms.SceneMgmt

ChangeScene

Action to change scene.

Variables

_sceneName

Scene to change to.

Methods

Do

Change the scene.

QuitApplication

Action to quit the application.

Methods

Do

Do quit the apllication.

SceneFieldAction

Action of type SceneField. Inherits from AtomAction<SceneField>.

SceneFieldPairAction

Action of type SceneFieldPair. Inherits from AtomAction<SceneFieldPair>.

SetSceneFieldVariableValue

Set variable value Action of type SceneField. Inherits from SetVariableValue<SceneField, SceneFieldPair, SceneFieldVariable, SceneFieldConstant, SceneFieldReference, SceneFieldEvent, SceneFieldPairEvent, SceneFieldVariableInstancer>.

SceneFieldCondition

Condition of type SceneField. Inherits from AtomCondition<SceneField>.

SceneFieldConstant

Constant of type SceneField. Inherits from AtomBaseVariable<SceneField>.

SceneFieldEventInstancer

Event Instancer of type SceneField. Inherits from AtomEventInstancer<SceneField, SceneFieldEvent>.

SceneFieldPairEventInstancer

Event Instancer of type SceneFieldPair. Inherits from AtomEventInstancer<SceneFieldPair, SceneFieldPairEvent>.

SceneFieldEventReferenceListener

Event Reference Listener of type SceneField. Inherits from AtomEventReferenceListener<SceneField, SceneFieldEvent, SceneFieldEventReference, SceneFieldUnityEvent>.

SceneFieldPairEventReferenceListener

Event Reference Listener of type SceneFieldPair. Inherits from AtomEventReferenceListener<SceneFieldPair, SceneFieldPairEvent, SceneFieldPairEventReference, SceneFieldPairUnityEvent>.

SceneFieldEventReference

Event Reference of type SceneField. Inherits from AtomEventReference<SceneField, SceneFieldVariable, SceneFieldEvent, SceneFieldVariableInstancer, SceneFieldEventInstancer>.

SceneFieldPairEventReference

Event Reference of type SceneFieldPair. Inherits from AtomEventReference<SceneFieldPair, SceneFieldVariable, SceneFieldPairEvent, SceneFieldVariableInstancer, SceneFieldPairEventInstancer>.

SceneFieldEvent

Event of type SceneField. Inherits from AtomEvent<SceneField>.

SceneFieldPairEvent

Event of type SceneFieldPair. Inherits from AtomEvent<SceneFieldPair>.

SceneFieldSceneFieldFunction

Function x 2 of type SceneField. Inherits from AtomFunction<SceneField, SceneField>.

SceneFieldPair

IPair of type <SceneField>. Inherits from IPair<SceneField>.

SceneFieldReference

Reference of type SceneField. Inherits from EquatableAtomReference<SceneField, SceneFieldPair, SceneFieldConstant, SceneFieldVariable, SceneFieldEvent, SceneFieldPairEvent, SceneFieldSceneFieldFunction, SceneFieldVariableInstancer, AtomCollection, AtomList>.

SyncSceneFieldVariableInstancerToCollection

Adds Variable Instancer's Variable of type SceneField to a Collection or List on OnEnable and removes it on OnDestroy.

SceneField

Struct to hold data about a scene.

Variables

_sceneAsset

The scene asset.

_sceneName

Name of the scene.

_scenePath

Path to the scene asset.

_buildIndex

Build index.

Properties

SceneName

Scene name as a property.

ScenePath

Scene path as a property.

BuildIndex

Build index as a property.

SceneAsset

Scene asset as a property.

Methods

Equals(UnityAtoms.SceneMgmt.SceneField)

Checks for equality between 2 SceneFields.

Parameters
  • other - The other SceneFiled to compare with.
Returns

true if they are equal, otherwise false.

Equals(System.Object)

Checks for equality using objects.

Parameters
  • other - The other scene field as an object to compare with.
Returns

true if they are equal, otherwise false.

GetHashCode

Get an unique hash code for this SceneField.

Returns

An unique hash.

op_Equality(UnityAtoms.SceneMgmt.SceneField,UnityAtoms.SceneMgmt.SceneField)

Equal operator.

Parameters
  • sf1 - The first SceneField to compare.
  • sf2 - The second SceneField to compare.
Returns

true if eqaul, otherwise false.

op_Inequality(UnityAtoms.SceneMgmt.SceneField,UnityAtoms.SceneMgmt.SceneField)

None equality operator.

Parameters
  • sf1 - The first SceneField to compare.
  • sf2 - The second SceneField to compare.
Returns

true if not eqaul, otherwise false.

SceneFieldPairUnityEvent

None generic Unity Event of type SceneFieldPair. Inherits from UnityEvent<SceneFieldPair>.

SceneFieldSceneFieldUnityEvent

None generic Unity Event x 2 of type SceneField. Inherits from UnityEvent<SceneField, SceneField>.

SceneFieldUnityEvent

None generic Unity Event of type SceneField. Inherits from UnityEvent<SceneField>.

SceneFieldValueList

Value List of type SceneField. Inherits from AtomValueList<SceneField, SceneFieldEvent>.

SceneFieldVariableInstancer

Variable Instancer of type SceneField. Inherits from AtomVariableInstancer<SceneFieldVariable, SceneFieldPair, SceneField, SceneFieldEvent, SceneFieldPairEvent, SceneFieldSceneFieldFunction>.

SceneFieldVariable

Variable of type SceneField. Inherits from EquatableAtomVariable<SceneField, SceneFieldPair, SceneFieldEvent, SceneFieldPairEvent, SceneFieldSceneFieldFunction>.