|
libHSPlasma
|
Universal Object IDentifier. More...
#include <plUoid.h>
Public Member Functions | |
| plUoid () | |
| bool | operator== (const plUoid &other) const |
| bool | operator!= (const plUoid &other) const |
| bool | operator< (const plUoid &other) const |
| void | read (hsStream *S) |
| void | write (hsStream *S) |
| void | prcWrite (pfPrcHelper *prc) |
| void | prcParse (const pfPrcTag *tag) |
| plString | toString () const |
| short | getType () const |
| const plString & | getName () const |
| const plLocation & | getLocation () const |
| const plLoadMask & | getLoadMask () const |
| unsigned int | getID () const |
| unsigned int | getCloneID () const |
| unsigned int | getClonePlayerID () const |
| void | setType (short type) |
| void | setName (const plString &name) |
| void | setLocation (const plLocation &loc) |
| void | setLoadMask (const plLoadMask &mask) |
| void | setID (unsigned int id) |
| void | setCloneIDs (unsigned int clone, unsigned int clonePlayer) |
Universal Object IDentifier.
This class contains the identification components to uniquely identify any KeyedObject within a game. This includes information such as name, type and location of the object, so it can be compared or looked up to find the actual object. Most notably, plUoid is used by plKey as an identification for the object that hte plKey references.
| plUoid::plUoid | ( | ) |
Constructs a new, empty Uoid
| unsigned int plUoid::getCloneID | ( | ) | const |
Returns the object's clone ID (useless)
| unsigned int plUoid::getClonePlayerID | ( | ) | const |
Returns the object's clone Player ID (useless)
| unsigned int plUoid::getID | ( | ) | const |
Returns the list ID for the object in the Page Key index. (Only meaningful for EoA and Hex Isle)
| const plLoadMask& plUoid::getLoadMask | ( | ) | const |
Returns the load mask of the object
| const plLocation& plUoid::getLocation | ( | ) | const |
Returns the location where the object is stored
| const plString& plUoid::getName | ( | ) | const |
Returns the name of the object
| short plUoid::getType | ( | ) | const |
Returns the class type of the object
| bool plUoid::operator!= | ( | const plUoid & | other | ) | const |
| bool plUoid::operator< | ( | const plUoid & | other | ) | const |
Compares two Uoids by contents, for use in STL containers
| bool plUoid::operator== | ( | const plUoid & | other | ) | const |
Compares two Uoids by contents. Only the location, type and name are actually compared – fields such as flags, object ID, and clone IDs are ignored in the comparison
| void plUoid::prcWrite | ( | pfPrcHelper * | prc | ) |
Read this Uoid as a plKey tag in a PRC document
| void plUoid::read | ( | hsStream * | S | ) |
Read this Uoid directly from a stream.
| void plUoid::setCloneIDs | ( | unsigned int | clone, |
| unsigned int | clonePlayer | ||
| ) |
Sets the Clone IDs for the object (useless)
| void plUoid::setID | ( | unsigned int | id | ) |
Set the list ID for the object within the Page Key index. This is only meaningful for EoA and Hex Isle, and should be left for the ResManager to handle automatically.
| void plUoid::setLoadMask | ( | const plLoadMask & | mask | ) |
Set the load mask of this Uoid and referenced object
| void plUoid::setLocation | ( | const plLocation & | loc | ) |
Set the location of the object referred to by this Uoid
| void plUoid::setName | ( | const plString & | name | ) |
Set the name of the object referred to by this Uoid
| void plUoid::setType | ( | short | type | ) |
Set the class type of the object referred to by this Uoid
| plString plUoid::toString | ( | ) | const |
Returns a string representation of the Uoid, in the form: "<seqPrefix|pageNum>[typeID]object_name"
| void plUoid::write | ( | hsStream * | S | ) |
Write this Uoid directly to a stream.
1.8.1.2