Suspend
Table of Contents
- suspendBuffByName() : mixed
- suspendBuffs() : void
- Suspend buffs if condition is true.
- suspendCompanions() : void
- Suspends companions on a given parameter.
- unsuspendBuffByName() : mixed
- unsuspendBuffs() : mixed
- unSuspendCompanions() : mixed
- Enables suspended companions.
Methods
suspendBuffByName()
public
suspendBuffByName(mixed $name[, mixed $msg = '' ]) : mixed
Parameters
- $name : mixed
- $msg : mixed = ''
Return values
mixed —suspendBuffs()
Suspend buffs if condition is true.
public
suspendBuffs([string $susp = '' ][, string $msg = '' ]) : void
Parameters
- $susp : string = ''
-
The type of suspension
- $msg : string = ''
-
the message to be displayed upon suspending
Return values
void —suspendCompanions()
Suspends companions on a given parameter.
public
suspendCompanions([string $susp = '' ][, string $msg = '' ]) : void
Parameters
- $susp : string = ''
-
The type of suspension
- $msg : string = ''
-
the message to be displayed upon suspending
Return values
void —unsuspendBuffByName()
public
unsuspendBuffByName(mixed $name[, mixed $msg = false ]) : mixed
Parameters
- $name : mixed
- $msg : mixed = false
Return values
mixed —unsuspendBuffs()
public
unsuspendBuffs([mixed $susp = false ][, mixed $msg = null ]) : mixed
Parameters
- $susp : mixed = false
- $msg : mixed = null
Return values
mixed —unSuspendCompanions()
Enables suspended companions.
public
unSuspendCompanions(string $susp[, string|null $nomsg = null ]) : mixed
Parameters
- $susp : string
-
The type of suspension
- $nomsg : string|null = null
-
The message to be displayed upon unsuspending. If null, no message will be displayed.