DoopelPonger
Public Attributes | Protected Member Functions | List of all members
TutorialTextSubstituteControls Class Reference

Step that needs to show text on the UI but also needs to substitute some of the text with KeyCodes the player(s) should press. The Step uses the string.Format method, so the {#} notation should be used to detect substitution. More...

Inheritance diagram for TutorialTextSubstituteControls:
Inheritance graph
[legend]
Collaboration diagram for TutorialTextSubstituteControls:
Collaboration graph
[legend]

Public Attributes

InputActionMapper.Action [] actionsToSubstitute
 
string textWithFillers
 
- Public Attributes inherited from TutorialShowText
string textToDisplay
 
float waitBetweenCharacters
 
- Public Attributes inherited from TutorialStep
TutorialStep singlePlayerNextStep
 
TutorialStep coopPlayerNextStep
 

Protected Member Functions

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

Additional Inherited Members

- Public Member Functions inherited from TutorialShowText
override bool TutorialUpdate (float deltaTime)
 Update tick of the tutorial. More...
 
override IDictionary< string, System.Object > Teardown ()
 Delete any objects that were created specifically for the duration of the step. 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...
 

Detailed Description

Step that needs to show text on the UI but also needs to substitute some of the text with KeyCodes the player(s) should press. The Step uses the string.Format method, so the {#} notation should be used to detect substitution.

Member Function Documentation

◆ ChildInit()

override GameObject [] TutorialTextSubstituteControls.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
tutorialManagerThe brains of the tutorial
gameModeThe 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.

Reimplemented from TutorialShowText.

Member Data Documentation

◆ actionsToSubstitute

InputActionMapper.Action [] TutorialTextSubstituteControls.actionsToSubstitute

The actions to be subtituted in the textWithFilters.

◆ textWithFillers

string TutorialTextSubstituteControls.textWithFillers

The raw text to be displayed on the UI.


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