Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
75 commits
Select commit Hold shift + click to select a range
35e67d6
Add xenoarchaeology module layout and shared definitions
Jackriip Nov 8, 2026
646af70
Add the artifact sprite sheet
Jackriip Nov 8, 2026
03e8160
Add the artifact core and the Nova artifact effects
Jackriip Nov 8, 2026
8c93939
Tidy artifact flavour text and brighten the idle glow
Jackriip Nov 8, 2026
a01a027
Give the specimen crate its own art and a lid tag
Jackriip Nov 8, 2026
24a561c
Sell dig finds to Barnaby, Boffin and Vex
Jackriip Nov 8, 2026
7a1ca41
core change: split capped artifact heals by the wounds present
Jackriip Nov 8, 2026
3b67b1b
Add the Polaris and VOREStation artifact effects
Jackriip Nov 8, 2026
1da2395
Have Sarge send dig finds round to Boffin
Jackriip Nov 8, 2026
e56c336
Add the artifact harvester, exotic battery and utilizer
Jackriip Nov 8, 2026
48a1902
Add the artifact analyser, scan pad, labeler and xenoarch research
Jackriip Nov 8, 2026
0a0ad77
Gate the Exotic Particles node behind yellow standing
Jackriip Nov 8, 2026
c879bfa
Add xenoarchaeology dig sites, boulders, strange rocks and dig tools
Jackriip Nov 8, 2026
d894d04
Review the Polaris artifact effects
Jackriip Nov 8, 2026
c4e3c71
Polish the dig reveal
Jackriip Nov 8, 2026
e03968e
Merge xenoarch dig part
Jackriip Nov 8, 2026
bae2a71
Merge xenoarch study part
Jackriip Nov 8, 2026
1a75c8d
Merge xenoarch use part
Jackriip Nov 8, 2026
764c54d
Merge xenoarch trade part
Jackriip Nov 8, 2026
b0de02b
Merge xenoarch effects part
Jackriip Nov 8, 2026
c9af08b
Add xenoarchaeology wiki page
Jackriip Nov 8, 2026
de9458b
Join the xenoarchaeology parts
Jackriip Nov 8, 2026
2c8846c
Fix runtimes in heal, hurt and labeler messages; scan pad sees spawne…
Jackriip Nov 8, 2026
5806d0a
Merge xenoarch wiki page
Jackriip Nov 8, 2026
40301f3
Describe loading the specimen crate and curio research on the xenoarc…
Jackriip Nov 8, 2026
40e67ee
Merge branch 'master' into feature/xenoarch
Jackriip Nov 8, 2026
48e749f
Let harmful artifact batteries act on whoever carries them
Jackriip Nov 8, 2026
cfde23a
Merge remote-tracking branch 'origin2/feature/xenoarch' into feature/…
Jackriip Nov 8, 2026
bcf73f2
Add the tutorial checklist core and retire the orientation briefing
Jackriip Nov 10, 2026
b8a6526
Add tutorial checklist hooks for ships, contracts and trade
Jackriip Nov 10, 2026
2c9dffc
Add the world, research, power and medical tutorial checklist hooks
Jackriip Nov 10, 2026
9e4c8b9
Merge branch 'feature/tutorial-hooks-c' into feature/tutorial-checklist
Jackriip Nov 10, 2026
dcfb77a
Tighten tutorial hooks: credit only real course changes, generator st…
Jackriip Nov 10, 2026
9ce471f
Add a dissection step to First surgery and a Vestige pact checklist item
Jackriip Nov 10, 2026
8dcd981
Add unit tests for the tutorial checklist catalog and hooks
Jackriip Nov 10, 2026
93abd41
Merge remote-tracking branch 'origin2/feature/hyperviolence-mega' int…
Jackriip Nov 10, 2026
f1d4bb3
Add a Do an execution step to the Cyberware tutorial
Jackriip Nov 10, 2026
4dc6a51
Merge remote-tracking branch 'origin2/master' into feature/tutorial-c…
Jackriip Nov 10, 2026
a1a0798
Merge remote-tracking branch 'origin2/feature/ship-saving' into featu…
Jackriip Nov 10, 2026
fc5e862
Add Storage, Repair drones and Save your ship tutorial items
Jackriip Nov 10, 2026
51959a1
Merge feature/hyperviolence-mega into the gene injector loot for test…
Jackriip Nov 10, 2026
47a318d
Merge feature/xenoarch into the tutorial checklist for test merging
Jackriip Nov 10, 2026
564ac58
Merge the gene injector test patch into the tutorial checklist for te…
Jackriip Nov 10, 2026
09d820f
Split tutorial research into R&D setup and Surveys, add outpost trave…
Jackriip Nov 10, 2026
6d3a5bc
Redesign the tutorial panel with categories, lessons, routes and a su…
Jackriip Nov 10, 2026
eb9fccc
Outline the open tutorial step's objects for the viewer
Jackriip Nov 10, 2026
e3e62bf
Add Ship weapons, Ship combat and Hunting pirates tutorial items
Jackriip Nov 10, 2026
e89234a
Merge branch 'feature/tutorial-combat' into feature/tutorial-checklist
Jackriip Nov 10, 2026
71ee54d
Merge remote-tracking branch 'origin2/feature/hyperviolence-mega' int…
Jackriip Nov 11, 2026
3e268be
Tutorial framework: guide step, live lines, off-screen arrow and in-w…
Jackriip Nov 11, 2026
6f5b11e
Ship and power tutorials: live state lines, locker and APC pointing, …
Jackriip Nov 11, 2026
d6ee578
Tutorial zones and ship weapons: research lines, staged build outline…
Jackriip Nov 11, 2026
4817451
Tutorial: ruin and vestige pointers, live lines and credit fixes
Jackriip Nov 11, 2026
87a83c5
Tutorial contract and trade steps: window focus, live lines, trader a…
Jackriip Nov 11, 2026
cecc7a8
Tutorial: cyberware and surgery steps point at what to do next
Jackriip Nov 11, 2026
2272be0
Tutorial: storage, repair drones and ship save step fixes, live lines…
Jackriip Nov 11, 2026
c950510
Tutorial R&D and Surveys: right targets, live lines and in-window focus
Jackriip Nov 11, 2026
442deeb
Tutorial content: ship combat and hunting pirates
Jackriip Nov 11, 2026
25ed63b
Merge tutorial content: ship-power
Jackriip Nov 11, 2026
60237d2
Merge tutorial content: contract-trade
Jackriip Nov 11, 2026
b9077b6
Merge tutorial content: research-surveys
Jackriip Nov 11, 2026
ae2dd21
Merge tutorial content: ruin-vestige
Jackriip Nov 11, 2026
0ac6d99
Merge tutorial content: chrome-surgery
Jackriip Nov 11, 2026
40240e9
Merge tutorial content: zones-weapons
Jackriip Nov 11, 2026
a591619
Merge tutorial content: combat-pirates
Jackriip Nov 11, 2026
6c9712b
Merge tutorial content: storage-drones-saves
Jackriip Nov 11, 2026
567a56f
Tutorial integration: shared window ids, autolathe, chrome tab and bo…
Jackriip Nov 11, 2026
8496df9
Tutorial R&D focus in the Techweb window the game uses; clear tab pul…
Jackriip Nov 11, 2026
5cde471
Untinted tutorial outlines on coloured mobs; keep downward arrows abo…
Jackriip Nov 11, 2026
5a75a99
Reset the target's colour on tutorial outlines
Jackriip Nov 11, 2026
3232eb8
Keep tutorial outlines apart from KEEP_TOGETHER targets so their tint…
Jackriip Nov 11, 2026
4629e4f
Make tutorial highlights pulse gold and keep outlines facing the same…
Jackriip Nov 11, 2026
8290dd1
Give tutorial outlines their target's facing
Jackriip Nov 11, 2026
3309314
Merge commit 'refs/tmp/pr518' into tmfix
Jackriip Nov 11, 2026
594585b
Merge commit '4a371e023941bc0c3e1f3494a994a9494ec2eb1e' into tmfix
Jackriip Nov 11, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 93 additions & 1 deletion tgstation.dme
Original file line number Diff line number Diff line change
Expand Up @@ -6750,6 +6750,8 @@
#include "voidcrew\_DEFINES\subsystems.dm"
#include "voidcrew\_DEFINES\techweb_nodes.dm"
#include "voidcrew\_DEFINES\trade.dm"
#include "voidcrew\_DEFINES\tutorials.dm"
#include "voidcrew\_DEFINES\xenoarch.dm"
#include "voidcrew\_HELPERS\data_huds.dm"
#include "voidcrew\_HELPERS\debug_atmos.dm"
#include "voidcrew\_HELPERS\docking.dm"
Expand Down Expand Up @@ -7571,7 +7573,6 @@
#include "voidcrew\modules\npc_ships\code\subtrees\combat_subtree.dm"
#include "voidcrew\modules\npc_ships\code\subtrees\movement_subtree.dm"
#include "voidcrew\modules\onboarding\first_time_notice.dm"
#include "voidcrew\modules\onboarding\orientation.dm"
#include "voidcrew\modules\onboarding\zone_advisory.dm"
#include "voidcrew\modules\outfits\corporate.dm"
#include "voidcrew\modules\outfits\misc.dm"
Expand Down Expand Up @@ -7897,6 +7898,27 @@
#include "voidcrew\modules\trade\favor_uniques\outfitter.dm"
#include "voidcrew\modules\trade\favor_uniques\pike.dm"
#include "voidcrew\modules\trade\favor_uniques\vex.dm"
#include "voidcrew\modules\tutorials\hooks_chrome_finisher.dm"
#include "voidcrew\modules\tutorials\hooks_contract.dm"
#include "voidcrew\modules\tutorials\hooks_medical.dm"
#include "voidcrew\modules\tutorials\hooks_pirates.dm"
#include "voidcrew\modules\tutorials\hooks_power.dm"
#include "voidcrew\modules\tutorials\hooks_repair_drones.dm"
#include "voidcrew\modules\tutorials\hooks_research.dm"
#include "voidcrew\modules\tutorials\hooks_ship.dm"
#include "voidcrew\modules\tutorials\hooks_ship_combat.dm"
#include "voidcrew\modules\tutorials\hooks_ship_save.dm"
#include "voidcrew\modules\tutorials\hooks_storage.dm"
#include "voidcrew\modules\tutorials\hooks_trade.dm"
#include "voidcrew\modules\tutorials\hooks_vestige.dm"
#include "voidcrew\modules\tutorials\hooks_world.dm"
#include "voidcrew\modules\tutorials\hooks_zones.dm"
#include "voidcrew\modules\tutorials\preferences.dm"
#include "voidcrew\modules\tutorials\tutorial_catalog.dm"
#include "voidcrew\modules\tutorials\tutorial_highlights.dm"
#include "voidcrew\modules\tutorials\tutorial_panel.dm"
#include "voidcrew\modules\tutorials\tutorial_progress.dm"
#include "voidcrew\modules\tutorials\tutorial_ship_hud.dm"
#include "voidcrew\modules\transporter\_transporter.dm"
#include "voidcrew\modules\transporter\transporter_console.dm"
#include "voidcrew\modules\transporter\transporter_designs.dm"
Expand All @@ -7919,6 +7941,76 @@
#include "voidcrew\modules\voice_barks\voice_screen.dm"
#include "voidcrew\modules\weapons_bench\ammunition.dm"
#include "voidcrew\modules\worldgen_logging\worldgen.dm"
#include "voidcrew\modules\xenoarch\core\artifact.dm"
#include "voidcrew\modules\xenoarch\core\artifact_appearance.dm"
#include "voidcrew\modules\xenoarch\core\artifact_effect.dm"
#include "voidcrew\modules\xenoarch\core\artifact_energy_kinds.dm"
#include "voidcrew\modules\xenoarch\core\artifact_helpers.dm"
#include "voidcrew\modules\xenoarch\core\artifact_label.dm"
#include "voidcrew\modules\xenoarch\core\artifact_pricing.dm"
#include "voidcrew\modules\xenoarch\dig\ambush.dm"
#include "voidcrew\modules\xenoarch\dig\boulder.dm"
#include "voidcrew\modules\xenoarch\dig\curios.dm"
#include "voidcrew\modules\xenoarch\dig\designs.dm"
#include "voidcrew\modules\xenoarch\dig\dig_reserve.dm"
#include "voidcrew\modules\xenoarch\dig\dig_sites.dm"
#include "voidcrew\modules\xenoarch\dig\finds.dm"
#include "voidcrew\modules\xenoarch\dig\site_walls.dm"
#include "voidcrew\modules\xenoarch\dig\spectrometer.dm"
#include "voidcrew\modules\xenoarch\dig\stabiliser.dm"
#include "voidcrew\modules\xenoarch\dig\strange_rock.dm"
#include "voidcrew\modules\xenoarch\dig\tools.dm"
#include "voidcrew\modules\xenoarch\effects\blood.dm"
#include "voidcrew\modules\xenoarch\effects\bodyhorror.dm"
#include "voidcrew\modules\xenoarch\effects\cell.dm"
#include "voidcrew\modules\xenoarch\effects\disgust.dm"
#include "voidcrew\modules\xenoarch\effects\emp.dm"
#include "voidcrew\modules\xenoarch\effects\feelings.dm"
#include "voidcrew\modules\xenoarch\effects\gas.dm"
#include "voidcrew\modules\xenoarch\effects\gravity.dm"
#include "voidcrew\modules\xenoarch\effects\hallucination.dm"
#include "voidcrew\modules\xenoarch\effects\health.dm"
#include "voidcrew\modules\xenoarch\effects\light.dm"
#include "voidcrew\modules\xenoarch\effects\noise.dm"
#include "voidcrew\modules\xenoarch\effects\radiation.dm"
#include "voidcrew\modules\xenoarch\effects\sleepy.dm"
#include "voidcrew\modules\xenoarch\effects\stun.dm"
#include "voidcrew\modules\xenoarch\effects\teleport.dm"
#include "voidcrew\modules\xenoarch\effects\temperature.dm"
#include "voidcrew\modules\xenoarch\effects\tesla.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\animate.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\berserk.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\disarm.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\electric_field.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\extinguisher.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\faraday.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\feysight.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\forcefield.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\fortify.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\gaia.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\gravity_wave.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\life_drain.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\life_steal.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\plasma_vent.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\poltergeist.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\resurrect.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\sleeping_gas.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\spines.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\sprint.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\status_effects.dm"
#include "voidcrew\modules\xenoarch\effects_polaris\sweat.dm"
#include "voidcrew\modules\xenoarch\study\analyser.dm"
#include "voidcrew\modules\xenoarch\study\labeler.dm"
#include "voidcrew\modules\xenoarch\study\research.dm"
#include "voidcrew\modules\xenoarch\study\scanpad.dm"
#include "voidcrew\modules\xenoarch\study\techweb.dm"
#include "voidcrew\modules\xenoarch\trade\buyers.dm"
#include "voidcrew\modules\xenoarch\trade\checkpoint.dm"
#include "voidcrew\modules\xenoarch\trade\metrics.dm"
#include "voidcrew\modules\xenoarch\trade\specimen_crate.dm"
#include "voidcrew\modules\xenoarch\use\battery.dm"
#include "voidcrew\modules\xenoarch\use\harvester.dm"
#include "voidcrew\modules\xenoarch\use\utilizer.dm"
#include "voidcrew\objects\items\blueprints.dm"
#include "voidcrew\objects\items\cards_ids.dm"
#include "voidcrew\objects\items\trash.dm"
Expand Down
7 changes: 6 additions & 1 deletion tgui/packages/tgui/interfaces/Autolathe.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import {
import { type BooleanLike, classes } from 'tgui-core/react';
import { capitalize } from 'tgui-core/string';

import { TutorialFocus } from '../../voidcrew_tgui/components/TutorialFocus'; // VOIDCREW EDIT ADDITION
import { useBackend } from '../backend';
import { Window } from '../layouts';
import { DesignBrowser } from './Fabrication/DesignBrowser';
Expand Down Expand Up @@ -221,7 +222,8 @@ const AutolatheRecipe = (props: AutolatheRecipeProps) => {
maxmult = Math.min(Math.floor(maxmult), 50);
const canPrint = maxmult > 0;

return (
// VOIDCREW EDIT CHANGE: was `return (`, wrapped below
const recipe = (
<div className="FabricatorRecipe">
<Tooltip content={design.desc} position="right">
<div
Expand Down Expand Up @@ -299,4 +301,7 @@ const AutolatheRecipe = (props: AutolatheRecipeProps) => {
</div>
</div>
);

// VOIDCREW EDIT ADDITION: the tutorial checklist outlines the design it points at.
return <TutorialFocus id={`autolathe_${design.id}`}>{recipe}</TutorialFocus>;
};
25 changes: 23 additions & 2 deletions tgui/packages/tgui/interfaces/Fabrication/DesignBrowser.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ import {
} from 'tgui-core/components';
import { classes } from 'tgui-core/react';

import { useSharedState } from '../../backend';
import { useBackend, useSharedState } from '../../backend'; // VOIDCREW EDIT CHANGE: useBackend
import { TutorialFocus } from '../../../voidcrew_tgui/components/TutorialFocus'; // VOIDCREW EDIT ADDITION
import { SearchBar } from '../common/SearchBar';
import type { Design, MaterialMap } from './Types';

Expand Down Expand Up @@ -355,7 +356,22 @@ const DesignBrowserTab = <T extends Design = Design>(
depth ??= 0;
maxDepth ??= 3;

return (
// VOIDCREW EDIT ADDITION START - the tutorial checklist pulses the top-level tab holding
// the circuit imprinter or autolathe design it points at (imprinter_<design id>,
// autolathe_<design id>).
const tutorialFocus =
useBackend<{ tutorial_focus?: string | null }>().data?.tutorial_focus || '';
const focusDesign =
/^(imprinter|autolathe)_(.+)$/.exec(tutorialFocus)?.[2] ?? '';
const tabFocused =
depth === 0 &&
!!focusDesign &&
selectedCategory !== category.title &&
!!category.descendants[focusDesign];
// VOIDCREW EDIT ADDITION END

// VOIDCREW EDIT CHANGE: was `return (`, wrapped below
const tab = (
<div
className={classes([
'FabricatorTabs__Tab',
Expand Down Expand Up @@ -403,6 +419,11 @@ const DesignBrowserTab = <T extends Design = Design>(
)}
</div>
);

// VOIDCREW EDIT ADDITION
return (
<TutorialFocus id={tabFocused ? tutorialFocus : ''}>{tab}</TutorialFocus>
);
};

type CategoryViewProps<T extends Design = Design> = {
Expand Down
9 changes: 8 additions & 1 deletion tgui/packages/tgui/interfaces/Fabricator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
} from 'tgui-core/components';
import { classes } from 'tgui-core/react';

import { TutorialFocus } from '../../voidcrew_tgui/components/TutorialFocus'; // VOIDCREW EDIT ADDITION
import { useBackend } from '../backend';
import { Window } from '../layouts';
import { DesignBrowser } from './Fabrication/DesignBrowser';
Expand Down Expand Up @@ -161,7 +162,8 @@ const Recipe = (props: RecipeProps) => {
!available[material] || amount > (available[material] ?? 0),
);

return (
// VOIDCREW EDIT CHANGE: was `return (`, wrapped below
const recipe = (
<div className="FabricatorRecipe">
<Tooltip content={design.desc} position="right">
<div
Expand Down Expand Up @@ -218,4 +220,9 @@ const Recipe = (props: RecipeProps) => {
<CustomPrint design={design} available={available} />
</div>
);

// VOIDCREW EDIT ADDITION: the tutorial checklist outlines the design it points at.
return (
<TutorialFocus id={`imprinter_${design.id}`}>{recipe}</TutorialFocus>
);
};
52 changes: 32 additions & 20 deletions tgui/packages/tgui/interfaces/SurgeryInitiator.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ import { Button, KeyListener, Stack } from 'tgui-core/components';
import { KEY_DOWN, KEY_ENTER, KEY_UP } from 'tgui-core/keycodes';
import type { BooleanLike } from 'tgui-core/react';

import { TutorialFocus } from '../../voidcrew_tgui/components/TutorialFocus'; // VOIDCREW EDIT ADDITION: tutorial checklist
import { useBackend } from '../backend';
import { Window } from '../layouts';
import { type BodyZone, BodyZoneSelector } from './common/BodyZoneSelector';

type Surgery = {
name: string;
blocked?: BooleanLike;
tutorial_id?: string; // VOIDCREW EDIT ADDITION: tutorial checklist
};

type SurgeryInitiatorData = {
Expand Down Expand Up @@ -77,33 +79,43 @@ class SurgeryInitiatorInner extends Component<
<Window width={400} height={350} title={`Surgery on ${target_name}`}>
<Window.Content scrollable>
<Stack fill height="100%">
<Stack.Item width="30%">
<BodyZoneSelector
onClick={(zone) => act('change_zone', { new_zone: zone })}
selectedZone={selected_zone}
/>
</Stack.Item>
{/* VOIDCREW EDIT CHANGE START: tutorial checklist focus (voidcrew/modules/tutorials) */}
<TutorialFocus id="surgery_chest">
<Stack.Item width="30%">
<BodyZoneSelector
onClick={(zone) => act('change_zone', { new_zone: zone })}
selectedZone={selected_zone}
/>
</Stack.Item>
</TutorialFocus>
{/* VOIDCREW EDIT CHANGE END */}

<Stack.Item width="95%">
<Stack vertical height="100%">
{/* VOIDCREW EDIT CHANGE START: tutorial checklist focus */}
{surgeries.map((surgery, index) => (
<Button
onClick={() => {
act('start_surgery', {
surgery_name: surgery.name,
});
}}
disabled={surgery.blocked}
selected={index === this.state.selectedSurgeryIndex}
tooltip={
surgery.blocked ? 'Their body is covered!' : undefined
}
<TutorialFocus
key={surgery.name}
fluid
id={surgery.tutorial_id || ''}
>
{surgery.name}
</Button>
<Button
onClick={() => {
act('start_surgery', {
surgery_name: surgery.name,
});
}}
disabled={surgery.blocked}
selected={index === this.state.selectedSurgeryIndex}
tooltip={
surgery.blocked ? 'Their body is covered!' : undefined
}
fluid
>
{surgery.name}
</Button>
</TutorialFocus>
))}
{/* VOIDCREW EDIT CHANGE END */}
</Stack>
</Stack.Item>
</Stack>
Expand Down
42 changes: 42 additions & 0 deletions tgui/packages/voidcrew_tgui/components/TutorialFocus.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/**
* Pulses a gold outline around one element while the tutorial checklist points at it.
*
* The window's ui_data sends `tutorial_focus` from `tutorial_ui_focus(user, "<window id>")`
* (voidcrew/modules/tutorials/tutorial_highlights.dm). Wrap each element a step can point
* at, giving it the focus key from that step's `ui_focus`:
*
* <TutorialFocus id="helm_dock"><button ...>Dock</button></TutorialFocus>
*
* It adds the `TutorialFocus` class to its one child and renders nothing of its own, so
* layout never changes. The child must pass `className` through to its DOM element: plain
* elements, tgui Button, Tabs.Tab, Table.Row and Box all do; a custom component needs a
* `className` prop. The outline is drawn inside the element, so a clipping parent can't
* hide it.
*/
import { Children, cloneElement, isValidElement, type ReactNode } from 'react';

import { useBackend } from '../backend';

type FocusData = { tutorial_focus?: string | null };

type Props = {
/** The focus key (or keys) this element answers to, e.g. "helm_dock". */
id: string | string[];
/** Overrides the window's `tutorial_focus`, for windows that send it under another name. */
focus?: string | null;
children: ReactNode;
};

export const TutorialFocus = (props: Props) => {
const { id, children } = props;
const { data } = useBackend<FocusData>();
const focus = props.focus === undefined ? data?.tutorial_focus : props.focus;
const matches = Array.isArray(id) ? id.includes(focus || '') : focus === id;
if (!focus || !matches) return <>{children}</>;
const child = Children.only(children);
if (!isValidElement<{ className?: string }>(child)) return <>{children}</>;
const existing = child.props.className;
return cloneElement(child, {
className: existing ? `${existing} TutorialFocus` : 'TutorialFocus',
});
};
Loading