Pol::Core::JusticeRegion Class Reference

#include <guardrgn.h>

Inheritance diagram for Pol::Core::JusticeRegion:

Public Member Functions
	JusticeRegion (Clib::ConfigElem &elem, RegionId id)
const std::string &	entertext () const
virtual size_t	estimateSize () const POL_OVERRIDE
const std::string &	leavetext () const
const std::string &	region_name () const
bool	RunEnterScript (Mobile::Character *chr)
bool	RunLeaveScript (Mobile::Character *chr)
Public Member Functions inherited from Pol::Core::Region
Bscript::BObjectImp *	get_region_string (const std::string &propname)
const std::string &	name () const
RegionId	regionid () const

Static Public Member Functions
static bool	RunNoCombatCheck (Network::Client *client)

Private Types
typedef Region	base

Private Attributes
std::string	enter_script_
std::string	entertext_
bool	guarded_
std::string	leave_script_
std::string	leavetext_
bool	nocombat_
std::string	region_name_

Additional Inherited Members
Protected Member Functions inherited from Pol::Core::Region
	Region (Clib::ConfigElem &elem, RegionId id)
virtual	~Region ()
void	read_custom_config (Clib::ConfigElem &elem)
Protected Attributes inherited from Pol::Core::Region
std::string	name_
PropertyList	proplist_
RegionId	regionid_

Detailed Description

Definition at line 40 of file guardrgn.h.

Member Typedef Documentation

typedef Region Pol::Core::JusticeRegion::base

private

Definition at line 42 of file guardrgn.h.

Constructor & Destructor Documentation

Pol::Core::JusticeRegion::JusticeRegion	(	Clib::ConfigElem &	elem,
		RegionId	id
	)

Definition at line 25 of file guardrgn.cpp.

Member Function Documentation

const std::string & Pol::Core::JusticeRegion::entertext ( ) const

inline

Definition at line 72 of file guardrgn.h.

Referenced by Pol::Mobile::Character::check_justice_region_change().

size_t Pol::Core::JusticeRegion::estimateSize ( ) const

virtual

Reimplemented from Pol::Core::Region.

Definition at line 46 of file guardrgn.cpp.

References enter_script_, entertext_, Pol::Core::Region::estimateSize(), leave_script_, leavetext_, and region_name_.

const std::string & Pol::Core::JusticeRegion::leavetext ( ) const

inline

Definition at line 77 of file guardrgn.h.

Referenced by Pol::Mobile::Character::check_justice_region_change().

const std::string & Pol::Core::JusticeRegion::region_name ( ) const

inline

Definition at line 67 of file guardrgn.h.

Referenced by Pol::Module::UOExecutorModule::mf_GetRegionName(), and Pol::Module::UOExecutorModule::mf_GetRegionNameAtLocation().

bool Pol::Core::JusticeRegion::RunEnterScript

(

Mobile::Character *

chr

)

Definition at line 55 of file guardrgn.cpp.

References Pol::Core::ScriptDef::config_nodie(), enter_script_, Pol::Core::ScriptDef::exists(), Pol::Bscript::BObjectImp::isTrue(), region_name_, and Pol::Core::run_script_to_completion().

Referenced by Pol::Mobile::Character::check_justice_region_change().

bool Pol::Core::JusticeRegion::RunLeaveScript

(

Mobile::Character *

chr

)

Definition at line 71 of file guardrgn.cpp.

References Pol::Core::ScriptDef::config_nodie(), Pol::Core::ScriptDef::exists(), Pol::Bscript::BObjectImp::isTrue(), leave_script_, region_name_, and Pol::Core::run_script_to_completion().

Referenced by Pol::Mobile::Character::check_justice_region_change().

bool Pol::Core::JusticeRegion::RunNoCombatCheck ( Network::Client *  client )

static

Definition at line 88 of file guardrgn.cpp.

References Pol::Network::Client::gd, Pol::Network::ClientGameData::justice_region, and nocombat_.

Referenced by Pol::Mobile::Character::check_justice_region_change(), Pol::Mobile::handle_attack(), and Pol::Core::TargetCursor::handle_target_cursor().

Member Data Documentation

std::string Pol::Core::JusticeRegion::enter_script_

private

Definition at line 63 of file guardrgn.h.

Referenced by estimateSize(), and RunEnterScript().

std::string Pol::Core::JusticeRegion::entertext_

private

Definition at line 61 of file guardrgn.h.

Referenced by estimateSize().

bool Pol::Core::JusticeRegion::guarded_

private

Definition at line 58 of file guardrgn.h.

std::string Pol::Core::JusticeRegion::leave_script_

private

Definition at line 64 of file guardrgn.h.

Referenced by estimateSize(), and RunLeaveScript().

std::string Pol::Core::JusticeRegion::leavetext_

private

Definition at line 62 of file guardrgn.h.

Referenced by estimateSize().

bool Pol::Core::JusticeRegion::nocombat_

private

Definition at line 59 of file guardrgn.h.

Referenced by RunNoCombatCheck().

std::string Pol::Core::JusticeRegion::region_name_

private

Definition at line 60 of file guardrgn.h.

Referenced by estimateSize(), RunEnterScript(), and RunLeaveScript().

---

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

• pol/guardrgn.h
• pol/guardrgn.cpp