A block to allow simple, non-parsed binary content. More...

Inheritance diagram for BinaryBlock:

Collaboration diagram for BinaryBlock:

Public Member Functions
	BinaryBlock ($type, $name, $content)
	Instantiate a BinaryBlock.
	Compile ()
	Compile the BinaryBlock.
	GetName ()
	Gets the PRAY block's name.
	GetData ()
	Gets the PRAY block's binary data if the PRAYBlock is decompiled.
	GetType ()
	Gets the type of PrayBlock this is.
	GetFlags ()
	Returns the flag bitfield used to determine flags.
	IsFlagSet ($flag)
	Tells you whether $flag is set on this PRAY block.
Related Functions
(Note that these are not member functions.)
Block Types
Constants for the various PRAY block types
enum	PRAY_BLOCK_AGNT
enum	PRAY_BLOCK_CREA
enum	PRAY_BLOCK_DFAM
enum	PRAY_BLOCK_DSAG
enum	PRAY_BLOCK_DSEX
enum	PRAY_BLOCK_EGGS
enum	PRAY_BLOCK_EXPC
enum	PRAY_BLOCK_FILE
enum	PRAY_BLOCK_GENE
enum	PRAY_BLOCK_GLST
enum	PRAY_BLOCK_LIVE
enum	PRAY_BLOCK_PHOT
enum	PRAY_BLOCK_SFAM
Flags
Flags used to specify how the block's data is stored.
enum	PRAY_FLAG_ZLIB_COMPRESSED
	Whether or not the block is zLib compressed. More...

Detailed Description

A block to allow simple, non-parsed binary content.

This class is essentially un-necessary, but it's good for debugging as you can use it to test PRAY compilation without needing to test individual block types' compilation.
Additionally, it allows us to create blocks for types we don't know of yet.
BinaryBlocks cannot be read from a PRAYFile.

Definition at line 13 of file BinaryBlock.php.

Member Function Documentation

BinaryBlock::BinaryBlock	(	$	type,
		$	name,
		$	content
	)

Instantiate a BinaryBlock.

Parameters:

$type	The four-character code for the block.
$name	The block's name.
$content	The content of the block as a binary string.

Definition at line 25 of file BinaryBlock.php.

BinaryBlock::Compile ( )

Compile the BinaryBlock.

Returns:: The compiled BinaryBlock as a binary string.

Reimplemented from PrayBlock.

Definition at line 33 of file BinaryBlock.php.

PrayBlock::GetData ( ) [inherited]

Gets the PRAY block's binary data if the PRAYBlock is decompiled.

It will decompress automatically if necessary, then unset the compressed flag. TODO: I'm not 100% sure I should keep this public... return the PRAY block's binary data.

Definition at line 153 of file PrayBlock.php.

PrayBlock::GetFlags ( ) [inherited]

Returns the flag bitfield used to determine flags.

Prefer using IsFlagSet. (This may be deprecated/removed in future releases) Least Significant Bit determines whether the block is compressed (1) or not. All other bits are 0 in all c2e-compatible PRAY blocks.

Returns:: an integer 0-255

Definition at line 179 of file PrayBlock.php.

PrayBlock::GetName ( ) [inherited]

Gets the PRAY block's name.

return the PRAY block's name

Definition at line 144 of file PrayBlock.php.

PrayBlock::GetType ( ) [inherited]

Gets the type of PrayBlock this is.

Gives the type as one of the PRAY_BLOCK_* constants - a four-character string, all in caps. These are defined above.

Returns:: One of the PRAY_BLOCK_* constants

Definition at line 170 of file PrayBlock.php.

PrayBlock::IsFlagSet ( $ flag ) [inherited]

Tells you whether $flag is set on this PRAY block.

Parameters:

$flag the bitfield to compare $flags to. As such can be multiple flags OR'd together.

Returns:: true or false.

Definition at line 187 of file PrayBlock.php.

Friends And Related Function Documentation

enum PRAY_BLOCK_AGNT [related, inherited]

Value: 'AGNT'

Definition at line 27 of file PrayBlock.php.

enum PRAY_BLOCK_CREA [related, inherited]

Value: 'CREA'

Definition at line 29 of file PrayBlock.php.

enum PRAY_BLOCK_DFAM [related, inherited]

Value: 'DFAM'

Definition at line 31 of file PrayBlock.php.

enum PRAY_BLOCK_DSAG [related, inherited]

Value: 'DSAG'

Definition at line 33 of file PrayBlock.php.

enum PRAY_BLOCK_DSEX [related, inherited]

Value: 'DSEX'

Definition at line 35 of file PrayBlock.php.

enum PRAY_BLOCK_EGGS [related, inherited]

Value: 'EGG'

Definition at line 37 of file PrayBlock.php.

enum PRAY_BLOCK_EXPC [related, inherited]

Value: 'EXPC'

Definition at line 39 of file PrayBlock.php.

enum PRAY_BLOCK_FILE [related, inherited]

Value: 'FILE'

Definition at line 41 of file PrayBlock.php.

enum PRAY_BLOCK_GENE [related, inherited]

Value: 'GENE'

Definition at line 43 of file PrayBlock.php.

enum PRAY_BLOCK_GLST [related, inherited]

Value: 'GLST'

Definition at line 45 of file PrayBlock.php.

enum PRAY_BLOCK_LIVE [related, inherited]

Value: 'LIVE'

Definition at line 47 of file PrayBlock.php.

enum PRAY_BLOCK_PHOT [related, inherited]

Value: 'PHOT'

Definition at line 49 of file PrayBlock.php.

enum PRAY_BLOCK_SFAM [related, inherited]

Value: 'SFAM'

Definition at line 51 of file PrayBlock.php.

enum PRAY_FLAG_ZLIB_COMPRESSED [related, inherited]

Whether or not the block is zLib compressed.

Value: 1

Definition at line 60 of file PrayBlock.php.

The documentation for this class was generated from the following file:

agents/PRAY/BinaryBlock.php

BinaryBlock Class Reference

Public Member Functions

Related Functions

Detailed Description

Member Function Documentation

Friends And Related Function Documentation