Show / Hide Table of Contents

Class SceneGroup

Inheritance
System.Object
SceneGroup
Namespace: Mannequin.Bindings
Assembly: Collapse.dll
Syntax
public class SceneGroup : object

Constructors

SceneGroup(List<Scene>)

Create a SceneGroup from a list of Scenes.

Declaration
public SceneGroup(List<Scene> scenes)
Parameters
Type Name Description
List<Scene> scenes

The scenes to generate the SceneGroup from.

SceneGroup(SceneOptions)

Procedurally generate a SceneGroup using the default generator and the provided options.

Declaration
public SceneGroup(SceneOptions opts)
Parameters
Type Name Description
SceneOptions opts

Methods

AddScene(Scene)

Add a Scene to this SceneGroup.

Declaration
public void AddScene(Scene sc)
Parameters
Type Name Description
Scene sc

The Scene to add

GetAllCargo(Faction)

Get all units with Cargo in this SceneGroup

Declaration
public List<Agent> GetAllCargo(Faction owner)
Parameters
Type Name Description
Faction owner

The owner faction

Returns
Type Description
List<Agent>

A list of all units with Cargo in this SceneGroup

GetScenes()

Get a list of the Scenes in this SceneGroup.

Declaration
public List<Scene> GetScenes()
Returns
Type Description
List<Scene>

A list of the Scenes in this SceneGroup

Launch(Int32)

Launch a game using this SceneGroup.

Declaration
public void Launch(int spawnOnSceneIndex = 0)
Parameters
Type Name Description
System.Int32 spawnOnSceneIndex

The scene to spawn on

RemoveScene(Scene)

Remove a Scene from this SceneGroup.

Declaration
public void RemoveScene(Scene sc)
Parameters
Type Name Description
Scene sc

The Scene to remove

SetActive()

Set this SceneGroup as the active SceneGroup and set the active scene to the first in this SceneGroup.

Consider using instead.

Declaration
public void SetActive()
Back to top © 2020 Anarkis Gaming. All rights reserved. Generated by DocFX