PrayBlock Class Reference

Abstract class to represent PRAY blocks. More...

Inheritance diagram for PrayBlock:

List of all members.

Public Member Functions
	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.
	Compile ()
	Compile this PrayBlock.
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

Abstract class to represent PRAY blocks.

Definition at line 64 of file PrayBlock.php.

---

Member Function Documentation

PrayBlock::Compile

(

)

Compile this PrayBlock.

Compiles the PrayBlock's data if necessary, then adds the header and returns the binary pray block.
This function is mainly intended for use by PRAYFiles.

Reimplemented in BinaryBlock.

Definition at line 253 of file PrayBlock.php.

PrayBlock::GetData

(

)

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

(

)

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

(

)

Gets the PRAY block's name.

return the PRAY block's name

Definition at line 144 of file PrayBlock.php.

PrayBlock::GetType

(

)

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

)

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]

Value: 'AGNT'

Definition at line 27 of file PrayBlock.php.

enum PRAY_BLOCK_CREA [related]

Value: 'CREA'

Definition at line 29 of file PrayBlock.php.

enum PRAY_BLOCK_DFAM [related]

Value: 'DFAM'

Definition at line 31 of file PrayBlock.php.

enum PRAY_BLOCK_DSAG [related]

Value: 'DSAG'

Definition at line 33 of file PrayBlock.php.

enum PRAY_BLOCK_DSEX [related]

Value: 'DSEX'

Definition at line 35 of file PrayBlock.php.

enum PRAY_BLOCK_EGGS [related]

Value: 'EGG'

Definition at line 37 of file PrayBlock.php.

enum PRAY_BLOCK_EXPC [related]

Value: 'EXPC'

Definition at line 39 of file PrayBlock.php.

enum PRAY_BLOCK_FILE [related]

Value: 'FILE'

Definition at line 41 of file PrayBlock.php.

enum PRAY_BLOCK_GENE [related]

Value: 'GENE'

Definition at line 43 of file PrayBlock.php.

enum PRAY_BLOCK_GLST [related]

Value: 'GLST'

Definition at line 45 of file PrayBlock.php.

enum PRAY_BLOCK_LIVE [related]

Value: 'LIVE'

Definition at line 47 of file PrayBlock.php.

enum PRAY_BLOCK_PHOT [related]

Value: 'PHOT'

Definition at line 49 of file PrayBlock.php.

enum PRAY_BLOCK_SFAM [related]

Value: 'SFAM'

Definition at line 51 of file PrayBlock.php.

enum PRAY_FLAG_ZLIB_COMPRESSED [related]

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/PrayBlock.php