ObjectFields Class Reference

#include <Object.h>

List of all members.

Public Member Functions
uint32 *	GetData ()
size_t	EncodeSQL (void *oData)
char *	EncodeSQL ()
bool	DecodeSQL (const char *iSqlStr)
void	SetLength (uint n)
	Set vector length.
uint	Length ()
	Get vector length in elements.
uint32	GetU32 (uint iIndex) const
	Get a uint32 value from the vector.
uint64	GetU64 (uint iIndex) const
	Get a uint64 value from the vector.
float	GetF32 (uint iIndex) const
	Get a float32 value from the vector.
void	SetU32 (uint iIndex, uint32 iValue)
	Set a uint32 value in the vector and update the changemask.
void	SetU64 (uint iIndex, uint64 iValue)
	Set a uint64 value in the vector and update the changemask.
void	SetF32 (uint iIndex, float iValue)
	Set a float value in the vector and update the changemask.
void	SetBits (uint iIndex, uint32 iMask, uint32 iValue)
void	Clear (uint iIndex, uint iCount)
	Clear a range of fields with zeros.

---

Detailed Description

Base class for every item, unit, player, corpse, container, etc

---

Member Function Documentation

bool ObjectFields::DecodeSQL

(

const char *

iSqlStr

)

[inline]

Decode the whole fields array from a text string that has been read from the SQL database.

• iSqlStr The SQL encoded string

  Returns:

  true if there was enough data for the fields, false if not

char* ObjectFields::EncodeSQL

(

)

[inline]

A simpler (but not always effective) version of EncodeSQL() that allocates and returns the encoded string directly

Returns:

A string that should be freed with delete []

size_t ObjectFields::EncodeSQL

(

void *

oData

)

[inline]

Encode the whole fields array into a minimal-overhead text string that can be stored into the SQL database.

• oData Pointer to output buffer or NULL to get the size required to hold the result. The buffer is assumed to have enough space.

  Returns:

  Number of bytes in the result, or number of bytes required to hold the result (if oData == NULL).

uint32* ObjectFields::GetData

(

)

[inline]

Get the Data variable,

void ObjectFields::SetBits	(	uint	iIndex,
		uint32	iMask,
		uint32	iValue
	)			[inline]

Set/reset bitflags. This method can be used to set or clear an arbitrary number of bitflags at once. The mask defines which bits are touched, and the value defines to which state these bits will be set. For example, SetBits (0xffffffff, 0) will reset all bits to 0, while SetBits (0xff, 0x0f) will set the lower 4 bits of the flags to 1, next 4 bits to 0 and the rest will remain untouched.

• iIndex Field index
• iMask The mask of bits to be modified
• iValue The value of the bits given by Mask

---

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

• My Documents/Visual Studio 2005/Projects/swgemu/src/Zone/Object.h
• My Documents/Visual Studio 2005/Projects/swgemu/src/Zone/Object.cpp

---