SpriteFile Class Reference

Superclass for all SpriteFile types. More...

Inheritance diagram for SpriteFile:

List of all members.

Public Member Functions
	GetFrame ($frame)
	Gets a SpriteFrame from the SpriteFile.
	GetFrames ()
	Gets the entire frame array.
	Compile ()
	Compiles the SpriteFile into a binary string.
	AddFrame (SpriteFrame $frame, $position=false)
	Adds a SpriteFrame to the SpriteFile.
	ReplaceFrame (SpriteFrame $frame, $position)
	Replaces a frame in the SpriteFile.
	GetFrameCount ()
	Gets the number of frames currently stored in this SpriteFile.
	DeleteFrame ($frame)
	Deletes the frame in the given position.
	ToPNG ($frame)
	Converts the given frame to PNG. Deprecated.

---

Detailed Description

Superclass for all SpriteFile types.

Definition at line 4 of file SpriteFile.php.

---

Member Function Documentation

SpriteFile::AddFrame	(	SpriteFrame $	frame,
		$	position = false
	)

Adds a SpriteFrame to the SpriteFile.

If necessary, this function converts the SpriteFrame to the correct format. At the moment, this can only add a SpriteFrame to the end of the SpriteFile. TODO: I aim to fix this by the CCSF 2011.

Parameters:

$frame	A SpriteFrame
$position	Where to put the frame. Currently un-used.

Definition at line 57 of file SpriteFile.php.

SpriteFile::Compile

(

)

[abstract]

Compiles the SpriteFile into a binary string.

Returns:

A binary string containing the SpriteFile's data and frames.

Reimplemented in C16File, S16File, and SPRFile.

SpriteFile::DeleteFrame

(

$

frame

)

Deletes the frame in the given position.

Parameters:

$frame

The 0-based index of the frame to delete.

Definition at line 98 of file SpriteFile.php.

SpriteFile::GetFrame

(

$

frame

)

Gets a SpriteFrame from the SpriteFile.

Parameters:

$frame

The 0-based index of the frame to get.

Returns:

A SpriteFrame

Definition at line 24 of file SpriteFile.php.

SpriteFile::GetFrameCount

(

)

Gets the number of frames currently stored in this SpriteFile.

Returns:

The number of frames

Definition at line 91 of file SpriteFile.php.

SpriteFile::GetFrames

(

)

Gets the entire frame array.

Returns:

An array of SpriteFrames

Definition at line 31 of file SpriteFile.php.

SpriteFile::ReplaceFrame	(	SpriteFrame $	frame,
		$	position
	)

Replaces a frame in the SpriteFile.

Replaces the frame in the given position Uses the same magic as AddFrame

Parameters:

$frame	A SpriteFrame of any type.
$position	Which frame to replace. If negative, counts backwards from the end of the frames array.

Definition at line 81 of file SpriteFile.php.

SpriteFile::ToPNG

(

$

frame

)

Converts the given frame to PNG. Deprecated.

May be removed in a future release. Use GetFrame($frame)->ToPNG() instead.

Parameters:

$frame

The 0-based index of the frame to delete.

Returns:

A binary string containing a PNG.

Definition at line 108 of file SpriteFile.php.

---

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

• sprites/SpriteFile.php