HoverRace::Script::Help::Event Class Reference

API documentation for a Lua event method. More...

#include <Event.h>

Inheritance diagram for HoverRace::Script::Help::Event:

Public Member Functions
	Event (const std::string &name)
	Constructor. More...
virtual	~Event ()
virtual void	Load (Util::yaml::MapNode *node)
Public Member Functions inherited from HoverRace::Script::Help::Method
	Method (const std::string &name)
	Constructor. More...
virtual	~Method ()
const std::string &	GetBrief () const
const std::string &	GetDesc () const
const std::string &	GetName () const
const sigs_t &	GetSigs () const

Private Types
typedef Method	SUPER

Additional Inherited Members
Public Types inherited from HoverRace::Script::Help::Method
using	examples_t = std::vector< std::string >
using	sigs_t = std::vector< std::string >
Protected Member Functions inherited from HoverRace::Script::Help::Method
sigs_t &	GetSigs ()
void	SetBrief (const std::string &s)
void	SetDesc (const std::string &s)

Detailed Description

API documentation for a Lua event method.

Author

Michael Imamura

Member Typedef Documentation

typedef Method HoverRace::Script::Help::Event::SUPER

private

Constructor & Destructor Documentation

HoverRace::Script::Help::Event::Event

(

const std::string &

name

)

Constructor.

Parameters

name	The name of the method.

HoverRace::Script::Help::Event::~Event ( )

virtual

Member Function Documentation

void HoverRace::Script::Help::Event::Load ( Util::yaml::MapNode *  node )

virtual

Reimplemented from HoverRace::Script::Help::Method.

---

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

• Event.h
• Event.cpp