Documentation

ToolTier
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
see

build/generate-registry-annotations.php

generate-registry-docblock

Table of Contents

$baseAttackPoints  : int
$baseEfficiency  : int
$enumName  : string
$harvestLevel  : int
$maxDurability  : int
$nextId  : int|null
$runtimeId  : int
DIAMOND()  : ToolTier
equals()  : bool
Returns whether the two objects are equivalent.
getAll()  : array<string|int, self>
Returns all members of the enum.
getBaseAttackPoints()  : int
getBaseEfficiency()  : int
getHarvestLevel()  : int
getMaxDurability()  : int
GOLD()  : ToolTier
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.
IRON()  : ToolTier
name()  : string
STONE()  : ToolTier
WOOD()  : ToolTier
register()  : void
Registers the given object as an enum member.
registerAll()  : void
setup()  : void
__construct()  : mixed

Properties

$baseAttackPoints

private int $baseAttackPoints

$baseEfficiency

private int $baseEfficiency

$maxDurability

private int $maxDurability

$nextId

private static int|null $nextId = null

Methods

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>

getBaseAttackPoints()

public getBaseAttackPoints() : int
Return values
int

getBaseEfficiency()

public getBaseEfficiency() : int
Return values
int

getHarvestLevel()

public getHarvestLevel() : int
Return values
int

getMaxDurability()

public getMaxDurability() : 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

name()

public name() : string
Return values
string

register()

Registers the given object as an enum member.

protected static register(self $member) : void
Parameters
$member : self
Tags
throws
InvalidArgumentException
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 $name, int $harvestLevel, int $maxDurability, int $baseAttackPoints, int $baseEfficiency) : mixed
Parameters
$name : string
$harvestLevel : int
$maxDurability : int
$baseAttackPoints : int
$baseEfficiency : int
Return values
mixed

Search results