TreeType
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
- $magicNumber : int
- $nextId : int|null
- $numericIdMap : array<string|int, TreeType>
- $runtimeId : int
- ACACIA() : TreeType
- BIRCH() : TreeType
- DARK_OAK() : TreeType
- equals() : bool
- Returns whether the two objects are equivalent.
- getAll() : array<string|int, self>
- Returns all members of the enum.
- getDisplayName() : string
- getMagicNumber() : int
- 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.
- JUNGLE() : TreeType
- name() : string
- OAK() : TreeType
- SPRUCE() : TreeType
- register() : void
- registerAll() : void
- setup() : void
- __construct() : mixed
Properties
$displayName
private
string
$displayName
$enumName
private
string
$enumName
$magicNumber
private
int
$magicNumber
$nextId
private
static int|null
$nextId
= null
$numericIdMap
private
static array<string|int, TreeType>
$numericIdMap
= []
$runtimeId
private
int
$runtimeId
Methods
ACACIA()
public
static ACACIA() : TreeType
Return values
TreeType —BIRCH()
public
static BIRCH() : TreeType
Return values
TreeType —DARK_OAK()
public
static DARK_OAK() : TreeType
Return values
TreeType —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 —getMagicNumber()
public
getMagicNumber() : int
Return values
int —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 —JUNGLE()
public
static JUNGLE() : TreeType
Return values
TreeType —name()
public
name() : string
Return values
string —OAK()
public
static OAK() : TreeType
Return values
TreeType —SPRUCE()
public
static SPRUCE() : TreeType
Return values
TreeType —register()
protected
static register(TreeType $type) : void
Parameters
- $type : TreeType
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, int $magicNumber) : mixed
Parameters
- $enumName : string
- $displayName : string
- $magicNumber : int