Step that will show text on the UI for the player to read. The text is updated a letter at a time, or until the MENU_SELECT InputTriggerOption is selected. Once that key is pressed the full text will be shown. Once the full text is shown then the player will need to press MENU_SELECt again to go to the next tutorial step. More...
Public Member Functions | |
| 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... | |
Public Attributes | |
| 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... | |
Detailed Description
Step that will show text on the UI for the player to read. The text is updated a letter at a time, or until the MENU_SELECT InputTriggerOption is selected. Once that key is pressed the full text will be shown. Once the full text is shown then the player will need to press MENU_SELECt again to go to the next tutorial step.
Member Function Documentation
◆ ChildInit()
|
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.
Reimplemented in TutorialShowTextWithPlayerListening, and TutorialTextSubstituteControls.
◆ 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()
|
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
◆ textToDisplay
| string TutorialShowText.textToDisplay |
Words to display on the UI.
◆ waitBetweenCharacters
| float TutorialShowText.waitBetweenCharacters |
The delay before showing the next character in the textToDisplay string.
The documentation for this class was generated from the following file:
- Assets/Scripts/Tutorial/TutorialShowText.cs
