ZoneLoadInfo Class Reference

Information for loading a specific zone. More...

#include <zonehandler.h>

Public Member Functions
bool	operator< (ZoneLoadInfo &other) const
	Basic comparison for less than. More...
bool	operator== (ZoneLoadInfo &other) const
	Basic comparison for equality. More...
	ZoneLoadInfo (iDocumentNode *node)
	Basic constructor built from a XML node. More...

Public Attributes
csString	inSector
	Which sector this zone applies to. More...
csString	loadImage
	Optional loading screen image. More...
csRef< iStringArray >	regions
	Regions to load on sector load. More...

Detailed Description

Information for loading a specific zone.

The ZoneHandler keeps a tree of these structures, loaded from an XML file, which specifies which regions are to be loaded when in that particular sector. Every sector in the world will need an entry in that xml file, because the client will use this list also when the game loads to make sure all relevant pieces are loaded no matter where the player's starting point is.

Definition at line 55 of file zonehandler.h.

Constructor & Destructor Documentation

ZoneLoadInfo::ZoneLoadInfo

(

iDocumentNode *

node

)

Basic constructor built from a XML node.

Builds the zone load information from the XML node. Attributes are mapped from "sector" to inSector and "loadimage" to loadImage. Each child node named "region" gets attribute "map" added to regions

Parameters

node	The XML node to extract the information out of

Member Function Documentation

bool ZoneLoadInfo::operator< ( ZoneLoadInfo &  other ) const

inline

Basic comparison for less than.

Compares one ZoneLoadInfo to another using inSector as the comparison field.

Parameters

other

The ZoneLoadInfo to compare to

Returns

True if the character comparison of inSector to other.inSector is < 0

Definition at line 93 of file zonehandler.h.

bool ZoneLoadInfo::operator== ( ZoneLoadInfo &  other ) const

inline

Basic comparison for equality.

Compares one ZoneLoadInfo to another using inSector as the comparison field.

Parameters

other

The ZoneLoadInfo to compare to

Returns

True if inSector == other.inSector, false otherwise

Definition at line 80 of file zonehandler.h.

Member Data Documentation

csString ZoneLoadInfo::inSector

Which sector this zone applies to.

Definition at line 58 of file zonehandler.h.

csString ZoneLoadInfo::loadImage

Optional loading screen image.

Definition at line 59 of file zonehandler.h.

csRef<iStringArray> ZoneLoadInfo::regions

Regions to load on sector load.

Definition at line 60 of file zonehandler.h.

---

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

• client/zonehandler.h