/datum/action/cooldown/spell/jaunt
A basic subtype for jaunt related spells. Jaunt spells put their caster in a dummy phased_mob effect that allows them to float around incorporeally.
Doesn't actually implement any behavior on cast to enter or exit the jaunt - that must be done via subtypes.
Use enter_jaunt() and exit_jaunt() as wrappers.
Vars | |
| jaunt_type | What dummy mob type do we put jaunters in on jaunt? |
|---|---|
Procs | |
| enter_jaunt | Places the [jaunter] in a jaunt holder mob If [loc_override] is supplied, the jaunt will be moved to that turf to start at |
| exit_jaunt | Ejects the [unjaunter] from jaunt The jaunt object in turn should call on_jaunt_exited If [loc_override] is supplied, the jaunt will be moved to that turf before ejecting the unjaunter |
| on_jaunt_exited | Called when a mob is ejected from the jaunt holder and goes back to normal. This is called both fom exit_jaunt() but also if the caster is ejected involuntarily for some reason. Use this to clear state data applied when jaunting, such as the trait TRAIT_MAGICALLY_PHASED. Arguments |
Var Details
jaunt_type
What dummy mob type do we put jaunters in on jaunt?
Proc Details
enter_jaunt
Places the [jaunter] in a jaunt holder mob If [loc_override] is supplied, the jaunt will be moved to that turf to start at
Returns the holder mob that was created
exit_jaunt
Ejects the [unjaunter] from jaunt The jaunt object in turn should call on_jaunt_exited If [loc_override] is supplied, the jaunt will be moved to that turf before ejecting the unjaunter
Returns TRUE on successful exit, FALSE otherwise
on_jaunt_exited
Called when a mob is ejected from the jaunt holder and goes back to normal. This is called both fom exit_jaunt() but also if the caster is ejected involuntarily for some reason. Use this to clear state data applied when jaunting, such as the trait TRAIT_MAGICALLY_PHASED. Arguments
- jaunt - The mob holder effect the caster has just exited
- unjaunter - The spellcaster who is no longer jaunting