|
c2ephp
|
Base block class for working with tag-type blocks. More...
Inheritance diagram for TagBlock: Collaboration diagram for TagBlock:Public Member Functions | |
| GetTag ($key) | |
| Gets the tag with the given name. | |
| GetTags () | |
| Gets all the tags from this block as an array of tags. | |
| SetTag ($tag, $value) | |
| Sets a tag. | |
| 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... | |
Base block class for working with tag-type blocks.
This includes (but may not be limited to) agents (AGNTBlock,DSAGBlock), creatures (EXPCBlock,DSEXBlock) and starter families (SFAMBlock,DFAMBlock)
This contains the majority of the meat of the tag block functions, including compilation and decompilation and maintaining a name->value tag array.
Subclasses of tag block are good for getting data in a more programmer-friendly way and for accessing data in the PRAYFile based on data within the TagBlock. For example, AGNTBlock can return a SpriteFrame for the image displayed on the Creator when that agent is selected.
Definition at line 18 of file TagBlock.php.
| PrayBlock::Compile | ( | ) | [inherited] |
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 | ( | ) | [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.
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.
| TagBlock::GetTag | ( | $ | key | ) |
Gets the tag with the given name.
Returns the tag's value as a string, or nothing if the tag doesn't exist.
Definition at line 44 of file TagBlock.php.
| TagBlock::GetTags | ( | ) |
Gets all the tags from this block as an array of tags.
This is mainly useful for people writing subclasses of TagBlock. If you have to write code that uses GetTags in your application, please file a bug report!
Definition at line 57 of file TagBlock.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.
Definition at line 170 of file PrayBlock.php.
| PrayBlock::IsFlagSet | ( | $ | flag | ) | [inherited] |
Tells you whether $flag is set on this PRAY block.
| $flag | the bitfield to compare $flags to. As such can be multiple flags OR'd together. |
Definition at line 187 of file PrayBlock.php.
| TagBlock::SetTag | ( | $ | tag, |
| $ | value | ||
| ) |
Sets a tag.
Sets the tag with the given value, overwriting or creating the tag as needed. Generally setters ought to be used in subclasses of TagBlock.
| $tag | Name of the tag to set |
| $value | The value to set the tag to |
Definition at line 69 of file TagBlock.php.
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] |
1.7.3 
