Eris::SpawnPoint Class Reference

Represents a possible spawn point as described by the server. When a new character is created on the server the user can select which "spawn point" the new character should spawn in. Each spawn point in turn will present a list of possible character types to select. More...

#include <SpawnPoint.h>

Public Member Functions
	SpawnPoint (const std::string &name, const CharacterTypeStore &availableCharacterTypes, const std::string &description)
	Ctor. More...
	~SpawnPoint ()
	Dtor.
const CharacterTypeStore &	getAvailableCharacterTypes () const
	Gets a list of available character types for this spawn point. More...
const std::string &	getName () const
	Gets the name of this spawn point. More...
const std::string &	getDescription () const
	Gets a description of this spawn point. More...

Detailed Description

Represents a possible spawn point as described by the server. When a new character is created on the server the user can select which "spawn point" the new character should spawn in. Each spawn point in turn will present a list of possible character types to select.

Author

Erik Hjortsberg erik..nosp@m.hjor.nosp@m.tsber.nosp@m.g@gm.nosp@m.ail.c.nosp@m.om

It's up to the client to determine how this will be presented. Either the client can first show a list of all available character types, as an aggregate of all spawn points, and then let the user select between different spawn points in the case that the character type is represented in multiple spawn points. Or the client can let the user initially select the spawn point to spawn in, and then present the available character. Or any other method.

Constructor & Destructor Documentation

SpawnPoint()

Eris::SpawnPoint::SpawnPoint	(	const std::string &	name,
		const CharacterTypeStore &	availableCharacterTypes,
		const std::string &	description
	)

Ctor.

Parameters

name	The name of the spawn point.
availableCharacterTypes	A list of available character types.
description	A description of the spawn point.

Member Function Documentation

getAvailableCharacterTypes()

const CharacterTypeStore & Eris::SpawnPoint::getAvailableCharacterTypes

(

)

const

Gets a list of available character types for this spawn point.

Returns

A list of available character types.

getDescription()

const std::string & Eris::SpawnPoint::getDescription

(

)

const

Gets a description of this spawn point.

Returns

A description of this spawn point.

getName()

const std::string & Eris::SpawnPoint::getName

(

)

const

Gets the name of this spawn point.

Returns

The name of this spawn point.

---

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

• SpawnPoint.h
• SpawnPoint.cpp