TutorialSpawnPlayers Class Reference

Step that spawns the players into the tutorial. More...

Inheritance diagram for TutorialSpawnPlayers:

Collaboration diagram for TutorialSpawnPlayers:

Public Member Functions
override IDictionary< string, System.Object >	Teardown ()
	Delete any objects that were created specifically for the duration of the step. More...
override bool	TutorialUpdate (float deltaTime)
	Update tick of the tutorial. More...
Public Member Functions inherited from TutorialStep
TutorialStep	GetNextStep ()
GameObject []	Init (TutorialManager tutorialManager, BoundriesCreator.GameMode gameMode)
	Set up any information need for the step. Method is call as soon as the step becomes active. More...

Public Attributes
float	timeToWait
GameObject []	players
TutorialPlayerPowerUpDecider	powerUpDecider
Public Attributes inherited from TutorialStep
TutorialStep	singlePlayerNextStep
TutorialStep	coopPlayerNextStep

Protected Member Functions
override GameObject []	ChildInit (TutorialManager manager, BoundriesCreator.GameMode gameMode)
	Set up any information need for the step. Method is call as soon as the step becomes active. More...

Detailed Description

Step that spawns the players into the tutorial.

Member Function Documentation

ChildInit()

override GameObject [] TutorialSpawnPlayers.ChildInit ( TutorialManager  tutorialManager, BoundriesCreator.GameMode  gameMode  )

protectedvirtual

Set up any information need for the step. Method is call as soon as the step becomes active.

Parameters

tutorialManager	The brains of the tutorial
gameMode	The mode of the tutorial

Returns

a list of gameobjects that are created and should live for the duration of the tutorial. The TutorialManager will destroy the objects when the tutorial is over.

Implements TutorialStep.

Teardown()

override IDictionary<string, System.Object> TutorialSpawnPlayers.Teardown ( )

virtual

Delete any objects that were created specifically for the duration of the step.

Returns

Any data needs to be carried between tutorial steps, like choices the player(s) make, return they data here and it will get added to the tutorialMetadata in the TutorialManager.

Implements TutorialStep.

TutorialUpdate()

override bool TutorialSpawnPlayers.TutorialUpdate ( float  deltaTime )

virtual

Update tick of the tutorial.

Parameters

deltaTime

The time since the last time this method was called.

Returns

True if the next step of the tutorial should be switched to. False, there's still work that needs to be done.

Implements TutorialStep.

Member Data Documentation

players

GameObject [] TutorialSpawnPlayers.players

The players that should be spawned.

powerUpDecider

TutorialPlayerPowerUpDecider TutorialSpawnPlayers.powerUpDecider

The tutorial specific power up provider to give to each player as they are spawned.

timeToWait

float TutorialSpawnPlayers.timeToWait

The time to wait after all the players have been spawned.

---

The documentation for this class was generated from the following file:

• Assets/Scripts/Tutorial/TutorialSpawnPlayers.cs