t1k:unity:tof:ftue
| Field | Value |
|---|---|
| Module | tof |
| Version | 2.2.2 |
| Effort | low |
| Tools | — |
Keywords: first-time-user, ftue, onboarding, tutorial
How to invoke
Section titled “How to invoke”/t1k:unity:tof:ftuePurpose
Section titled “Purpose”This module contains the User Experience components for the First Time User Experience (FTUE) system. It provides conditions and actions to control when and how UI components are shown to guide new users through the game.
Public API
Section titled “Public API”class
FinishFTUECondition(FinishFTUECondition.cs)FTUEHighlightShouldShowComponentAction(FTUEHighlightShouldShowComponentAction.cs)FTUELoseFlowShowComponentCondition(FTUELoseFlowShowComponentCondition.cs)FTUEShowComponentCondition(FTUEShowComponentCondition.cs)
Signals / Events
Section titled “Signals / Events”None detected.
Config / ScriptableObjects
Section titled “Config / ScriptableObjects”None detected.
Integration Steps
Section titled “Integration Steps”- Reference package
TheOneFeaturein your project. - Register the FTUE services via VContainer (see Architecture).
- Configure any ScriptableObjects listed in Config section.
- Subscribe to signals listed in Signals / Events to react to state changes.
Architecture
Section titled “Architecture”Detected public types (4): class
FinishFTUECondition(FinishFTUECondition.cs)FTUEHighlightShouldShowComponentAction(FTUEHighlightShouldShowComponentAction.cs)FTUELoseFlowShowComponentCondition(FTUELoseFlowShowComponentCondition.cs)FTUEShowComponentCondition(FTUEShowComponentCondition.cs)
Dependencies
Section titled “Dependencies”Run with FEATURE_MATRIX/DEPENDENCY_GRAPH integration to fill.
Gotchas
Section titled “Gotchas”(None reported yet — open an issue in The1Studio/theonekit-unity if you hit one.)
References
Section titled “References”- Source:
UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/FTUE/ - Doc:
UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/FTUE/UserExperience/README.md - Doc:
UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/FTUE/CHANGELOG.md - Doc:
UnityTheOneFeatureProject/Packages/TheOneFeature/Core/Features/FTUE/UserExperience/CHANGELOG.md - Namespace:
TheOne.Features.FTUE.Common,TheOne.Features.FTUE.UserExperience