t1k:unity:tof:ftue
| Field | Value |
|---|---|
| Module | tof |
| Version | 3.46.8 |
| Effort | low |
| Tools | — |
Keywords: first-time-user, ftue, onboarding
How to invoke
Section titled “How to invoke”/t1k:unity:tof:ftueScope — this is a candidate index, not an inventory. This skill indexes one source folder. A feature can span
Assets/TheOneFeature/,Packages/com.gdk.*, and siblingAssets/TheOne.*packages, and this skill will only show the folder it was built from. A capability missing here is not evidence that it is absent — verify against source (grep over a stated scope) before concluding anything does not exist. See The1Studio/theonekit-unity#350.
Purpose
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.
⚠️ This is the condition/action glue, NOT the tutorial framework. The 4 types below are the complete public surface of
Assets/TheOneFeature/Core/Features/FTUE/(6.csfiles) — but that folder is not the framework. The actual FTUE system is a sibling package:
Concern Where Tutorial framework Assets/TheOne.FTUE/— 67.csfiles, 71 public typesShow/hide glue documented here Assets/TheOneFeature/Core/Features/FTUE/— 4 typesNo
tof-*skill documentsTheOne.FTUE. A tutorial framework exists; it has been reported absent on the strength of this skill’s four glue classes. See #350.
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”Not yet documented. This section was never filled in; it is a known gap, not a
statement that the feature has no dependencies. Read the .asmdef next to the source
folder above for the authoritative list.
Hard rules
Section titled “Hard rules”- Writing a custom
FTUEAction(orFTUECondition) in game code needs BOTHusing TheOne.FTUE;andusing TheOne.FTUE.Common;— the base classesFTUEAction,FTUECondition,FTUESequencelive in namespaceTheOne.FTUE(assemblyTheOne.FTUE), while the library’s concrete actions and helpers (FocusController,FocusElement,FTUEUnfocusAction,IFTUEWorldTargetProvider,FTUEWaitForSignalAction<T>) live inTheOne.FTUE.Common(assemblyTheOne.FTUE.Common). Importing only.CommongivesCS0246: 'FTUEAction' could not be found. The game asmdef must reference both assemblies.FTUEAction.DoAction()ispublic abstract; overrideOnDispose()to clean up objects an action created, and callCompleted()on every path or the step never advances. Source: SlingSmash FTUE ball-count hint session. - Library FTUE world helpers cannot raise a world-space object above the dim: the root UI canvas is Screen Space Overlay, so the focus dim (
FocusBg, black 80% alpha, sorting order 1) always draws over world text and meshes. The only ways to make a world object visible through it are a mask hole (FTUEFocusWorldTargetAction) or a UI copy raised withFocusController.FocusUI(name)(the copy needs aFocusElement). Tooltip anchorFTUETooltipAnchorsits 410 canvas units below the indicator root, tuned for the golden stacks, so a target low on screen puts the tooltip off-screen; add a second anchor above the root in the indicator prefab variant. Source: same session.
References
Section titled “References”- Source:
Assets/TheOneFeature/Core/Features/FTUE/ - Doc:
Assets/TheOneFeature/Core/Features/FTUE/UserExperience/README.md - Doc:
Assets/TheOneFeature/Core/Features/FTUE/CHANGELOG.md - Doc:
Assets/TheOneFeature/Core/Features/FTUE/UserExperience/CHANGELOG.md - Namespace:
TheOne.Features.FTUE.Common,TheOne.Features.FTUE.UserExperience