Skip to content

t1k:unity:tof:ftue

FieldValue
Moduletof
Version3.46.8
Effortlow
Tools—

Keywords: first-time-user, ftue, onboarding

/t1k:unity:tof:ftue

Scope — this is a candidate index, not an inventory. This skill indexes one source folder. A feature can span Assets/TheOneFeature/, Packages/com.gdk.*, and sibling Assets/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.

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 .cs files) — but that folder is not the framework. The actual FTUE system is a sibling package:

ConcernWhere
Tutorial frameworkAssets/TheOne.FTUE/ — 67 .cs files, 71 public types
Show/hide glue documented hereAssets/TheOneFeature/Core/Features/FTUE/ — 4 types

No tof-* skill documents TheOne.FTUE. A tutorial framework exists; it has been reported absent on the strength of this skill’s four glue classes. See #350.

class

  • FinishFTUECondition (FinishFTUECondition.cs)
  • FTUEHighlightShouldShowComponentAction (FTUEHighlightShouldShowComponentAction.cs)
  • FTUELoseFlowShowComponentCondition (FTUELoseFlowShowComponentCondition.cs)
  • FTUEShowComponentCondition (FTUEShowComponentCondition.cs)

None detected.

None detected.

  1. Reference package TheOneFeature in your project.
  2. Register the FTUE services via VContainer (see Architecture).
  3. Configure any ScriptableObjects listed in Config section.
  4. Subscribe to signals listed in Signals / Events to react to state changes.

Detected public types (4): class

  • FinishFTUECondition (FinishFTUECondition.cs)
  • FTUEHighlightShouldShowComponentAction (FTUEHighlightShouldShowComponentAction.cs)
  • FTUELoseFlowShowComponentCondition (FTUELoseFlowShowComponentCondition.cs)
  • FTUEShowComponentCondition (FTUEShowComponentCondition.cs)

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.

  • Writing a custom FTUEAction (or FTUECondition) in game code needs BOTH using TheOne.FTUE; and using TheOne.FTUE.Common; — the base classes FTUEAction, FTUECondition, FTUESequence live in namespace TheOne.FTUE (assembly TheOne.FTUE), while the library’s concrete actions and helpers (FocusController, FocusElement, FTUEUnfocusAction, IFTUEWorldTargetProvider, FTUEWaitForSignalAction<T>) live in TheOne.FTUE.Common (assembly TheOne.FTUE.Common). Importing only .Common gives CS0246: 'FTUEAction' could not be found. The game asmdef must reference both assemblies. FTUEAction.DoAction() is public abstract; override OnDispose() to clean up objects an action created, and call Completed() 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 with FocusController.FocusUI(name) (the copy needs a FocusElement). Tooltip anchor FTUETooltipAnchor sits 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.
  • 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