newbee

Vars
_needed_item	Reference to the currently needed item
_target_hud_elements	A reference to the currently targeted hud elements for HUD highlighting
custom_advance_sound	an optional custom sound to use when advancing this step
highlight_hud_element	Which HUD element to highlight, by ID
highlight_hud_marker	The icon state to apply to the HUD
hud_point	Current HUD point
keymap	Reference to the player's keymapping
needed_item_path	A needed item to complete this tutorial step. Will attempt to find the object on the player and highlight it. Failing that, it will create one.
newbee_tutorial	Reference to our newbee tutorial
region	Reference to the tutorial's region
sidebar	Which sidebar to display; see NEWBEE_TUTORIAL_SIDEBAR_*
step_area	Associated area of the step. Used to handle warping for previous step
Procs
highlight_hud	highlight a specific hud element
highlight_needed_item	highlight a needed item, including the inventory slot if on the character
hud_point_loop	Loops a hud pointer until the step moves on
update_instructions	update instruction text. IMPORTANT: tail-call parent to update properly

Var Details

var
_needed_item
– /obj/item

Reference to the currently needed item

var
_target_hud_elements
– /list/atom/movable/screen/hud

A reference to the currently targeted hud elements for HUD highlighting

var
custom_advance_sound

an optional custom sound to use when advancing this step

var
highlight_hud_element

Which HUD element to highlight, by ID

var
highlight_hud_marker

The icon state to apply to the HUD

var
hud_point
– /obj/decal/point

Current HUD point

var
keymap
– /datum/keymap

Reference to the player's keymapping

var
needed_item_path

A needed item to complete this tutorial step. Will attempt to find the object on the player and highlight it. Failing that, it will create one.

var
newbee_tutorial
– /datum/tutorial_base/regional/newbee

Reference to our newbee tutorial

var
region
– /datum/allocated_region

Reference to the tutorial's region

Which sidebar to display; see NEWBEE_TUTORIAL_SIDEBAR_*

var
step_area
– /area/tutorial/newbee

Associated area of the step. Used to handle warping for previous step

Proc Details

proc
highlight_hud
(hud_element, hud_marker)

highlight a specific hud element

proc
highlight_needed_item
(item_path)

highlight a needed item, including the inventory slot if on the character

proc
hud_point_loop
(step_number, x_offset, y_offset)

Loops a hud pointer until the step moves on

proc
update_instructions
()

update instruction text. IMPORTANT: tail-call parent to update properly

/datum/tutorialStep/newbee

Vars

Procs

Var Details

var _needed_item – /obj/item

var _target_hud_elements – /list/atom/movable/screen/hud

var custom_advance_sound

var highlight_hud_element

var highlight_hud_marker

var hud_point – /obj/decal/point

var keymap – /datum/keymap

var needed_item_path

var newbee_tutorial – /datum/tutorial_base/regional/newbee

var region – /datum/allocated_region

var sidebar

var step_area – /area/tutorial/newbee