Inheritance diagram for stmg::XmlRandomEventParser:

Public Member Functions
	XmlRandomEventParser ()

Event *	parseEvent (GameCtx &oCtx, const xmlpp::Element *p0Element) override
	Parse and create an event instance. More...

int32_t	parseEventMsgName (ConditionalCtx &oCtx, const xmlpp::Element *p0Element, const std::string &sAttr, const std::string &sMsgName) override
	Returns event type's msg value from msg name. More...

int32_t	parseEventListenerGroupName (GameCtx &oCtx, const xmlpp::Element *p0Element, const std::string &sAttr, const std::string &sListenerGroupName) override
	Returns event type listener group value from name. More...

Public Member Functions inherited from stmg::XmlEventParser
virtual	~XmlEventParser ()=default

	XmlEventParser (const std::string &sEventName)
	Constructor. More...

const std::string &	getEventName () const
	The event name. More...

virtual void	recycleEvents (std::unique_ptr< Event > &refEvent)
	Recycle the event if it is of a type created by this instance. More...

Additional Inherited Members
Protected Member Functions inherited from stmg::XmlEventParser
bool	getBlock (GameCtx &oCtx, const std::string &sName, Block &oBlock)
	Return named block. More...

Event *	parseChildEvent (GameCtx &oCtx, const xmlpp::Element *p0Element)
	Parses an event and adds it to the level. More...

void	parseEventBase (GameCtx &oCtx, const xmlpp::Element *p0Element, Event::Init &oInit)
	Parse event base. More...

Event *	integrateAndAdd (GameCtx &oCtx, unique_ptr< Event > refEvent, const xmlpp::Element *p0Element)
	Integrate the event add to level. More...

int32_t	parseEventAttrRepeat (GameCtx &oCtx, const xmlpp::Element *p0EventElement)
	Helper function for the 'repeat' attribute. More...

int32_t	parseEventAttrStep (GameCtx &oCtx, const xmlpp::Element *p0EventElement)
	Helper function for the 'step' attribute. More...

int32_t	parseEventAttrRandomProb (GameCtx &oCtx, const xmlpp::Element *p0EventElement)
	Helper function for the 'prob' attribute. More...

bool	isReservedChildElementOfEvent (const std::string &sElementName) const
	Tells whether a child element name of Event is reserved. More...

XmlConditionalParser &	getXmlConditionalParser ()
	Get the conditional parser. More...

XmlTraitsParser &	getXmlTraitsParser ()
	Get the traits parser. More...

Constructor & Destructor Documentation

◆ XmlRandomEventParser()

stmg::XmlRandomEventParser::XmlRandomEventParser ( )

Member Function Documentation

◆ parseEvent()

Event* stmg::XmlRandomEventParser::parseEvent	(	GameCtx &	oCtx,
		const xmlpp::Element *	p0Element
	)

overridevirtual

Parse and create an event instance.

The implementation must call integrateAndAdd() to add the newly created event to the level which will own it.

Parameters

oCtx	The game context.
p0Element	The element. Cannot be null.

Returns: The created event. Non owning. Is not null.

Exceptions

std::runtime_error.

Implements stmg::XmlEventParser.

◆ parseEventListenerGroupName()

int32_t stmg::XmlRandomEventParser::parseEventListenerGroupName	(	GameCtx &	oCtx,
		const xmlpp::Element *	p0Element,
		const std::string &	sAttr,
		const std::string &	sListenerGroupName
	)

overridevirtual

Returns event type listener group value from name.

Usually listener group the name is the same as defined in the event class as an enum without the 'LISTENER_GROUP_' prefix.

Since also the Event base class has at least the LISTENER_GROUP_FINISHED enum and therefore the name 'FINISHED' defined, subclasses of this function should call XmlEventParser::parseEventListenerGroupName() after checking their own enums.

Parameters

oCtx	The game context.
p0Element	The element containing the the attribute. Cannot be null.
sAttr	The attribute name containing the listener group name. Cannot be empty.
sListenerGroupName	The listener group name. Cannot be empty.

Returns: The listener group value.

Exceptions

If	the listener group name is unknown.

Reimplemented from stmg::XmlEventParser.

◆ parseEventMsgName()

int32_t stmg::XmlRandomEventParser::parseEventMsgName	(	ConditionalCtx &	oCtx,
		const xmlpp::Element *	p0Element,
		const std::string &	sAttr,
		const std::string &	sMsgName
	)

overridevirtual

Returns event type's msg value from msg name.

Usually the msg name is the same as defined in the event class as an enum without the 'MESSAGE_' prefix.

Subclasses of this function should call XmlEventParser::parseEventMsgName() after checking their own enums. The function will throw an error.

Parameters

oCtx	The game context.
p0Element	The element containing the the attribute. Cannot be null.
sAttr	The attribute name containing the message name. Cannot be empty.
sMsgName	The message name. Cannot be empty.

Returns: The message value.

Exceptions

If	the msg name is unknown.

Reimplemented from stmg::XmlEventParser.

Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ XmlRandomEventParser()

Member Function Documentation

◆ parseEvent()

◆ parseEventListenerGroupName()

◆ parseEventMsgName()