Phpcraft\NBT\CompoundTag Class Reference

Inheritance diagram for Phpcraft\NBT\CompoundTag:

Collaboration diagram for Phpcraft\NBT\CompoundTag:

Public Member Functions
	__construct (string $name, array $children=[])
	hasChild (string $name)
	write (Connection $con, bool $inList=false)
	copy ()
	__toString ()
	toSNBT (bool $fancy=false, bool $inList=false)
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	offsetExists ($offset)
	offsetGet ($offset)
	getChild (string $name)
	offsetSet ($offset, $value)
	addChild (NBT $tag)
	offsetUnset ($offset)
	count ()

Public Attributes
const	ORD = 10
	$children
Public Attributes inherited from Phpcraft\NBT\NBT
const	ORD = null
	$name

Additional Inherited Members
Static Public Member Functions inherited from Phpcraft\NBT\NBT
static	fromString (string $nbt)
static	fromSNBT (string $snbt, bool $inList=false)
static	stringFromSNBT (string $snbt)
static	isValidBareString (string $string)
static	stringToSNBT (string $string)
Protected Member Functions inherited from Phpcraft\NBT\NBT
	_write (Connection $con)
Static Protected Member Functions inherited from Phpcraft\NBT\NBT
static	parseSNBTArray (string $snbt, bool $list)
static	indentString (string $string)

Constructor & Destructor Documentation

__construct()

Phpcraft\NBT\CompoundTag::__construct	(	string	$name,
		array	$children = []
	)

Parameters

string	$name	The name of this tag.
	array<NBT>	$children The child tags of the compound.

Member Function Documentation

__toString()

Phpcraft\NBT\CompoundTag::__toString

(

)

Reimplemented from Phpcraft\NBT\NBT.

addChild()

Phpcraft\NBT\CompoundTag::addChild

(

NBT

$tag

)

Adds a child to the compound or replaces an existing one by the same name.

Parameters

NBT

$tag

Returns

CompoundTag $this

copy()

Phpcraft\NBT\CompoundTag::copy

(

)

Returns

static

Reimplemented from Phpcraft\NBT\NBT.

count()

Phpcraft\NBT\CompoundTag::count

(

)

current()

Phpcraft\NBT\CompoundTag::current

(

)

getChild()

Phpcraft\NBT\CompoundTag::getChild

(

string

$name

)

Gets a child of the compound by its name or null if not found.

Parameters

string

$name

Returns

NBT

hasChild()

Phpcraft\NBT\CompoundTag::hasChild

(

string

$name

)

Returns true if the compound has a child with the given name.

Parameters

string

$name

Returns

boolean

key()

Phpcraft\NBT\CompoundTag::key

(

)

next()

Phpcraft\NBT\CompoundTag::next

(

)

offsetExists()

Phpcraft\NBT\CompoundTag::offsetExists

(

$offset

)

offsetGet()

Phpcraft\NBT\CompoundTag::offsetGet

(

$offset

)

offsetSet()

Phpcraft\NBT\CompoundTag::offsetSet	(		$offset,
			$value
	)

offsetUnset()

Phpcraft\NBT\CompoundTag::offsetUnset

(

$offset

)

rewind()

Phpcraft\NBT\CompoundTag::rewind

(

)

toSNBT()

Phpcraft\NBT\CompoundTag::toSNBT	(	bool	$fancy = false,
		bool	$inList = false
	)

Returns the NBT tag in SNBT (stringified NBT) format, as used in commands.

Parameters

bool	$fancy
boolean	$inList	Ignore this parameter.

Returns

string

Reimplemented from Phpcraft\NBT\NBT.

valid()

Phpcraft\NBT\CompoundTag::valid

(

)

write()

Phpcraft\NBT\CompoundTag::write	(	Connection	$con,
		bool	$inList = false
	)

Adds the NBT tag to the write buffer of the connection.

Parameters

Connection	$con
boolean	$inList	Ignore this parameter.

Returns

Connection $con

Reimplemented from Phpcraft\NBT\NBT.

Member Data Documentation

$children

SplObjectStorage Phpcraft\NBT\CompoundTag::$children

The child tags of the compound.

ORD

const Phpcraft\NBT\CompoundTag::ORD = 10