Strongman
Overview
The Strongman component coordinates the player's gym workout activity. It is responsible for tagging the player while in the gym ("ingym"), storing the reference to the current gym instance, and pausing or resuming the Mightiness component to reflect active workout state transitions.
Dependencies & Tags
- Component dependency:
mightiness(assumed to be present on the entity) - Tag added:
"ingym"(during workout) - Tag removed:
"ingym"(when workout ends)
Properties
| Property | Type | Default Value | Description |
|---|---|---|---|
gym | Entity? | nil | Reference to the gym structure the player is currently working out at. Set in DoWorkout, cleared in StopWorkout. |
Note: The constructor
Class(function(self, inst) self.inst = inst end)initializes onlyself.inst. Thegymproperty is assigned later on first use.
Main Functions
DoWorkout(gym)
- Description: Begins a gym workout session for the player. Pauses the Mightiness component and adds the
"ingym"tag to the entity. - Parameters:
gym(Entity) — The gym structure entity the player is entering to train.
StopWorkout()
- Description: Ends the current gym workout session. Removes the
"ingym"tag, resumes the Mightiness component, and clears the storedgymreference. - Parameters:
None.
Events & Listeners
None identified.