Option
Table of Contents
- $options : array<string|int, mixed>
- Options of battle.
- getOption() : mixed
- Get an option by name.
- getOptions() : array<string|int, mixed>
- Get all of options.
- getOptionType() : string|null
- Get type (same as battle zone).
- optionsBattleActive() : self
- Mark battle that as active.
- optionsBattleDeactive() : self
- Mark battle that as deactive.
- setOption() : self
- Set an option by name (replace if exists).
- setOptions() : self
- Set the value of options (replace all options).
- setOptionType() : self
- Set type (same as battle zone).
Properties
$options
Options of battle.
protected
array<string|int, mixed>
$options
= []
Methods
getOption()
Get an option by name.
public
getOption(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
Return values
mixed —getOptions()
Get all of options.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOptionType()
Get type (same as battle zone).
public
getOptionType() : string|null
Return values
string|null —optionsBattleActive()
Mark battle that as active.
public
optionsBattleActive() : self
Return values
self —optionsBattleDeactive()
Mark battle that as deactive.
public
optionsBattleDeactive() : self
Return values
self —setOption()
Set an option by name (replace if exists).
public
setOption(string $key, mixed $value) : self
Parameters
- $key : string
- $value : mixed
Return values
self —setOptions()
Set the value of options (replace all options).
public
setOptions(array<string|int, mixed> $options) : self
Parameters
- $options : array<string|int, mixed>
Return values
self —setOptionType()
Set type (same as battle zone).
public
setOptionType(string $type) : self
Parameters
- $type : string