Documentation

PotionType
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

$displayName  : string
$effectsGetter  : Closure
$enumName  : string
$nextId  : int|null
$runtimeId  : int
AWKWARD()  : PotionType
equals()  : bool
Returns whether the two objects are equivalent.
FIRE_RESISTANCE()  : PotionType
getAll()  : array<string|int, self>
Returns all members of the enum.
getDisplayName()  : string
getEffects()  : array<string|int, EffectInstance>
HARMING()  : PotionType
HEALING()  : PotionType
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.
INVISIBILITY()  : PotionType
LEAPING()  : PotionType
LONG_FIRE_RESISTANCE()  : PotionType
LONG_INVISIBILITY()  : PotionType
LONG_LEAPING()  : PotionType
LONG_MUNDANE()  : PotionType
LONG_NIGHT_VISION()  : PotionType
LONG_POISON()  : PotionType
LONG_REGENERATION()  : PotionType
LONG_SLOW_FALLING()  : PotionType
LONG_SLOWNESS()  : PotionType
LONG_STRENGTH()  : PotionType
LONG_SWIFTNESS()  : PotionType
LONG_TURTLE_MASTER()  : PotionType
LONG_WATER_BREATHING()  : PotionType
LONG_WEAKNESS()  : PotionType
MUNDANE()  : PotionType
name()  : string
NIGHT_VISION()  : PotionType
POISON()  : PotionType
REGENERATION()  : PotionType
SLOW_FALLING()  : PotionType
SLOWNESS()  : PotionType
STRENGTH()  : PotionType
STRONG_HARMING()  : PotionType
STRONG_HEALING()  : PotionType
STRONG_LEAPING()  : PotionType
STRONG_POISON()  : PotionType
STRONG_REGENERATION()  : PotionType
STRONG_STRENGTH()  : PotionType
STRONG_SWIFTNESS()  : PotionType
STRONG_TURTLE_MASTER()  : PotionType
SWIFTNESS()  : PotionType
THICK()  : PotionType
TURTLE_MASTER()  : PotionType
WATER()  : PotionType
WATER_BREATHING()  : PotionType
WEAKNESS()  : PotionType
WITHER()  : PotionType
register()  : void
Registers the given object as an enum member.
registerAll()  : void
setup()  : void
__construct()  : mixed

Properties

$effectsGetter

private Closure $effectsGetter
Tags
phpstan-var

\Closure() : list<EffectInstance>

$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>

getDisplayName()

public getDisplayName() : string
Return values
string

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 $enumName, string $displayName, Closure $effectsGetter) : mixed
Parameters
$enumName : string
$displayName : string
$effectsGetter : Closure
Tags
phpstan-param

\Closure() : list<EffectInstance> $effectsGetter

Return values
mixed

Search results