unity-atoms/docs/api/unityatoms.scenemgmt.md

299 lines
5.6 KiB
Markdown
Raw Permalink Normal View History

2019-10-15 22:39:42 +02:00
---
id: unityatoms.scenemgmt
title: UnityAtoms.SceneMgmt
hide_title: true
sidebar_label: UnityAtoms.SceneMgmt
---
# Namespace - `UnityAtoms.SceneMgmt`
2020-03-02 20:12:38 +01:00
## `SceneFieldPairEventReferenceListener`
2020-03-21 23:03:14 +01:00
Event Reference Listener of type `SceneFieldPair`. Inherits from `AtomEventReferenceListener<SceneFieldPair, SceneFieldPairEvent, SceneFieldPairEventReference, SceneFieldPairUnityEvent>`.
2020-03-02 20:12:38 +01:00
---
## `SceneFieldEventReferenceListener`
2020-03-21 23:03:14 +01:00
Event Reference Listener of type `SceneField`. Inherits from `AtomEventReferenceListener<SceneField, SceneFieldEvent, SceneFieldEventReference, SceneFieldUnityEvent>`.
2020-03-02 20:12:38 +01:00
---
2019-10-15 23:31:21 +02:00
## `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 `SceneField`s.
##### Parameters
- `other` - The other `SceneFiled` to compare with.
##### Returns
`true` if they are equal, otherwise `false`.
---
#### `Equals(System.Object)`
Checks for equality using `object`s.
##### 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`.
---
2020-01-23 23:42:09 +01:00
## `SceneFieldReference`
2020-03-21 23:03:14 +01:00
Reference of type `SceneField`. Inherits from `EquatableAtomReference<SceneField, SceneFieldPair, SceneFieldConstant, SceneFieldVariable, SceneFieldEvent, SceneFieldPairEvent, SceneFieldSceneFieldFunction, SceneFieldVariableInstancer, AtomCollection, AtomList>`.
2020-03-02 20:12:38 +01:00
---
## `SceneFieldPair`
IPair of type `<SceneField>`. Inherits from `IPair<SceneField>`.
---
## `SceneFieldPairUnityEvent`
None generic Unity Event of type `SceneFieldPair`. Inherits from `UnityEvent<SceneFieldPair>`.
2020-01-23 23:42:09 +01:00
---
2019-10-15 22:39:42 +02:00
## `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>`.
---
2020-01-23 23:42:09 +01:00
## `SceneFieldConstant`
Constant of type `SceneField`. Inherits from `AtomBaseVariable<SceneField>`.
---
2020-03-02 20:12:38 +01:00
## `SceneFieldPairEventReference`
2020-02-24 00:59:35 +01:00
2020-03-02 20:12:38 +01:00
Event Reference of type `SceneFieldPair`. Inherits from `AtomEventReference<SceneFieldPair, SceneFieldVariable, SceneFieldPairEvent, SceneFieldVariableInstancer, SceneFieldPairEventInstancer>`.
2020-02-24 00:59:35 +01:00
---
2020-03-02 20:12:38 +01:00
## `SceneFieldEventReference`
2020-02-24 00:59:35 +01:00
2020-03-02 20:12:38 +01:00
Event Reference of type `SceneField`. Inherits from `AtomEventReference<SceneField, SceneFieldVariable, SceneFieldEvent, SceneFieldVariableInstancer, SceneFieldEventInstancer>`.
2020-02-24 00:59:35 +01:00
---
## `SceneFieldVariableInstancer`
2020-03-02 20:12:38 +01:00
Variable Instancer of type `SceneField`. Inherits from `AtomVariableInstancer<SceneFieldVariable, SceneFieldPair, SceneField, SceneFieldEvent, SceneFieldPairEvent, SceneFieldSceneFieldFunction>`.
---
## `SceneFieldEventInstancer`
Event Instancer of type `SceneField`. Inherits from `AtomEventInstancer<SceneField, SceneFieldEvent>`.
---
## `SceneFieldPairEventInstancer`
Event Instancer of type `SceneFieldPair`. Inherits from `AtomEventInstancer<SceneFieldPair, SceneFieldPairEvent>`.
2020-02-24 00:59:35 +01:00
---
2019-10-15 22:39:42 +02:00
## `SceneFieldVariable`
2020-03-02 20:12:38 +01:00
Variable of type `SceneField`. Inherits from `EquatableAtomVariable<SceneField, SceneFieldPair, SceneFieldEvent, SceneFieldPairEvent, SceneFieldSceneFieldFunction>`.
---
2020-12-30 00:47:17 +01:00
## `SceneFieldCondition`
Condition of type `SceneField`. Inherits from `AtomCondition<SceneField>`.
---
2020-03-02 20:12:38 +01:00
## `SceneFieldPairAction`
Action of type `SceneFieldPair`. Inherits from `AtomAction<SceneFieldPair>`.
2019-10-15 22:39:42 +02:00
---
2020-01-23 23:42:09 +01:00
## `QuitApplication`
Action to quit the application.
### Methods
#### `Do`
Do quit the apllication.
---
## `ChangeScene`
Action to change scene.
### Variables
#### `_sceneName`
Scene to change to.
### Methods
#### `Do`
Change the scene.
---
## `SceneFieldAction`
Action of type `SceneField`. Inherits from `AtomAction<SceneField>`.
---
2020-02-24 00:59:35 +01:00
## `SceneFieldSceneFieldFunction`
Function x 2 of type `SceneField`. Inherits from `AtomFunction<SceneField, SceneField>`.
---
2020-03-21 23:03:14 +01:00
## `SyncSceneFieldVariableInstancerToCollection`
Adds Variable Instancer's Variable of type SceneField to a Collection or List on OnEnable and removes it on OnDestroy.
---
2020-03-02 20:12:38 +01:00
## `SceneFieldPairEvent`
2020-01-23 23:42:09 +01:00
2020-03-02 20:12:38 +01:00
Event of type `SceneFieldPair`. Inherits from `AtomEvent<SceneFieldPair>`.
2020-01-23 23:42:09 +01:00
---
2020-03-02 20:12:38 +01:00
## `SceneFieldEvent`
2020-01-23 23:42:09 +01:00
2020-03-02 20:12:38 +01:00
Event of type `SceneField`. Inherits from `AtomEvent<SceneField>`.
2020-02-24 00:59:35 +01:00
---
## `SceneFieldValueList`
Value List of type `SceneField`. Inherits from `AtomValueList<SceneField, SceneFieldEvent>`.
2020-01-23 23:42:09 +01:00
---
## `SetSceneFieldVariableValue`
2020-03-02 20:12:38 +01:00
Set variable value Action of type `SceneField`. Inherits from `SetVariableValue<SceneField, SceneFieldPair, SceneFieldVariable, SceneFieldConstant, SceneFieldReference, SceneFieldEvent, SceneFieldPairEvent, SceneFieldVariableInstancer>`.
2020-01-23 23:42:09 +01:00
---