Documentation

RecordType
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

$enumName  : string
$nextId  : int|null
$runtimeId  : int
$soundId  : int
$soundName  : string
$translatableName  : Translatable
DISK_11()  : RecordType
DISK_13()  : RecordType
DISK_BLOCKS()  : RecordType
DISK_CAT()  : RecordType
DISK_CHIRP()  : RecordType
DISK_FAR()  : RecordType
DISK_MALL()  : RecordType
DISK_MELLOHI()  : RecordType
DISK_STAL()  : RecordType
DISK_STRAD()  : RecordType
DISK_WAIT()  : RecordType
DISK_WARD()  : RecordType
equals()  : bool
Returns whether the two objects are equivalent.
getAll()  : array<string|int, self>
Returns all members of the enum.
getSoundId()  : int
getSoundName()  : string
getTranslatableName()  : Translatable
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.
name()  : string
register()  : void
Registers the given object as an enum member.
registerAll()  : void
setup()  : void
__construct()  : mixed

Properties

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

getSoundId()

public getSoundId() : int
Return values
int

getSoundName()

public getSoundName() : 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 $soundName, int $soundId, Translatable $translatableName) : mixed
Parameters
$enumName : string
$soundName : string
$soundId : int
$translatableName : Translatable
Return values
mixed

Search results