WifTutorialAlarm
Overview
Shown when the player sets off a physical alarm object in the world. This is one of the minimal tutorial files in the category: it defines only the message and a fixed completion timer, with no self-registered activation trigger at all.
Inheritance
- Inherits from:
MrxTutorial(src/resident/mrxtutorial.lua) β a real corpus module, already documented under Resident Modules, not an opaque native-only engine class despite this file living insrc/vz/. - Imports: none
Instance pattern
A subclass of the corpusβs MrxTutorial task-framework base class β self-based lifecycle overrides, not the Inheritable/uGuid object pattern used in resident/. No module-level or per-instance state beyond what the base class itself tracks (_tEvents).
Functions
GetMessage()
Returns the fixed message key "[Tutorial.Alarms]".
SetupCompletionCriteria(self)
Standard pattern: a 10-second Event.TimerRelative that calls self.EndTutorial(self, true).
Events
Event.TimerRelativeβ 10-second completion delay inSetupCompletionCriteria.
Notes for modders
- Trigger key:
"Alarm". NoSetupActivationCriteriaoverride exists in this file at all β it inherits the base classβs empty no-op, so it can never self-arm from any event. Confirmed sole activation path:Alarm(resident/alarm.lua) callsMrxTutorialManager.StartTutorial("Alarm")directly, right after arming an alarm objectβs deactivation events and starting its own 60-second mute timer β i.e. this fires whenever the player sets off a resident alarm object, bypassingSetupActivationCriteriaentirely. - No
SetupCancellationCriteriaoverride either β inherits the base no-op.