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

API documentation for a Lua class. More...

#include <Class.h>

Public Types
using	methods_t = std::map< const std::string, std::shared_ptr< Method >>

Public Member Functions
	Class (const std::string &name)
	Constructor. More...
void	AddMethod (std::shared_ptr< Method > method)
std::shared_ptr< Method >	GetMethod (const std::string &methodName) const
const methods_t &	GetMethods () const
const std::string &	GetName () const
void	Load (Util::yaml::MapNode *node)

Private Member Functions
	Class ()=delete

Private Attributes
methods_t	methods
std::string	name

Detailed Description

API documentation for a Lua class.

Author

Michael Imamura

Member Typedef Documentation

using HoverRace::Script::Help::Class::methods_t = std::map<const std::string, std::shared_ptr<Method>>

Constructor & Destructor Documentation

HoverRace::Script::Help::Class::Class ( )

privatedelete

HoverRace::Script::Help::Class::Class

(

const std::string &

name

)

Constructor.

Parameters

name	The name of the class.

Member Function Documentation

void HoverRace::Script::Help::Class::AddMethod

(

std::shared_ptr< Method >

method

)

std::shared_ptr< Method > HoverRace::Script::Help::Class::GetMethod

(

const std::string &

methodName

)

const

const methods_t& HoverRace::Script::Help::Class::GetMethods ( ) const

inline

const std::string& HoverRace::Script::Help::Class::GetName ( ) const

inline

void HoverRace::Script::Help::Class::Load

(

Util::yaml::MapNode *

node

)

Member Data Documentation

methods_t HoverRace::Script::Help::Class::methods

private

std::string HoverRace::Script::Help::Class::name

private

---

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

• Class.h
• Class.cpp