DyeColor
in package
Uses
EnumTrait
This doc-block is generated automatically, do not modify it manually.
This must be regenerated whenever registry members are added, removed or changed.
Tags
Table of Contents
- $displayName : string
- $enumName : string
- $nextId : int|null
- $rgbValue : Color
- $runtimeId : int
- BLACK() : DyeColor
- BLUE() : DyeColor
- BROWN() : DyeColor
- CYAN() : DyeColor
- equals() : bool
- Returns whether the two objects are equivalent.
- getAll() : array<string|int, self>
- Returns all members of the enum.
- getDisplayName() : string
- getRgbValue() : Color
- GRAY() : DyeColor
- GREEN() : DyeColor
- id() : int
- Returns a runtime-only identifier for this enum member. This will be different with each run, so don't try to hardcode it.
- LIGHT_BLUE() : DyeColor
- LIGHT_GRAY() : DyeColor
- LIME() : DyeColor
- MAGENTA() : DyeColor
- name() : string
- ORANGE() : DyeColor
- PINK() : DyeColor
- PURPLE() : DyeColor
- RED() : DyeColor
- WHITE() : DyeColor
- YELLOW() : DyeColor
- register() : void
- Registers the given object as an enum member.
- registerAll() : void
- setup() : void
- __construct() : mixed
Properties
$displayName
private
string
$displayName
$enumName
private
string
$enumName
$nextId
private
static int|null
$nextId
= null
$rgbValue
private
Color
$rgbValue
$runtimeId
private
int
$runtimeId
Methods
BLACK()
public
static BLACK() : DyeColor
Return values
DyeColor —BLUE()
public
static BLUE() : DyeColor
Return values
DyeColor —BROWN()
public
static BROWN() : DyeColor
Return values
DyeColor —CYAN()
public
static CYAN() : DyeColor
Return values
DyeColor —equals()
Returns whether the two objects are equivalent.
public
equals(self $other) : bool
Parameters
- $other : self
Return values
bool —getAll()
Returns all members of the enum.
public
static getAll() : array<string|int, self>
This is overridden to change the return typehint.
Return values
array<string|int, self> —getDisplayName()
public
getDisplayName() : string
Return values
string —getRgbValue()
public
getRgbValue() : Color
Return values
Color —GRAY()
public
static GRAY() : DyeColor
Return values
DyeColor —GREEN()
public
static GREEN() : DyeColor
Return values
DyeColor —id()
Returns a runtime-only identifier for this enum member. This will be different with each run, so don't try to hardcode it.
public
id() : int
This can be useful for switches or array indexing.
Return values
int —LIGHT_BLUE()
public
static LIGHT_BLUE() : DyeColor
Return values
DyeColor —LIGHT_GRAY()
public
static LIGHT_GRAY() : DyeColor
Return values
DyeColor —LIME()
public
static LIME() : DyeColor
Return values
DyeColor —MAGENTA()
public
static MAGENTA() : DyeColor
Return values
DyeColor —name()
public
name() : string
Return values
string —ORANGE()
public
static ORANGE() : DyeColor
Return values
DyeColor —PINK()
public
static PINK() : DyeColor
Return values
DyeColor —PURPLE()
public
static PURPLE() : DyeColor
Return values
DyeColor —RED()
public
static RED() : DyeColor
Return values
DyeColor —WHITE()
public
static WHITE() : DyeColor
Return values
DyeColor —YELLOW()
public
static YELLOW() : DyeColor
Return values
DyeColor —register()
Registers the given object as an enum member.
protected
static register(self $member) : void
Parameters
- $member : self
Tags
Return values
void —registerAll()
protected
static registerAll(self ...$members) : void
Parameters
- $members : self
Return values
void —setup()
protected
static setup() : void
Return values
void —__construct()
private
__construct(string $enumName, string $displayName, Color $rgbValue) : mixed
Parameters
- $enumName : string
- $displayName : string
- $rgbValue : Color