MapCheckerT Class Reference

The common base class for concrete map checkers. More...

Inheritance diagram for MapCheckerT:

Public Member Functions
	MapCheckerT (MapDocumentT &MapDoc, IntrusivePtrT< CompMapEntityT > Ent)
	The constructor. More...
virtual	~MapCheckerT ()
	The virtual destructor. More...
IntrusivePtrT< CompMapEntityT >	GetEnt () const
	Returns the entity that this checker is assigned to. More...
virtual bool	HasProblem () const
	Returns whether this map checker has actually identified a problem with the entity it is assigned to. More...
virtual bool	CanFix () const
	Returns whether this checker is able to provide a fix the problem (some problems can only be detected, but not fixed). More...
virtual CommandT *	GetFix () const
	Returns a command that fixes the problem, if possible (that is, when HasProblem() and CanFix() returns true). Returns NULL otherwise. More...
virtual wxString	GetInfo () const
	Returns a brief information about the nature of the problem. More...
virtual wxString	GetHelpText () const
	Returns a longer help text about the details of the problem and how it can be fixed. More...

Protected Attributes
MapDocumentT &	m_MapDoc
IntrusivePtrT< CompMapEntityT >	m_Ent

Detailed Description

The common base class for concrete map checkers.

Constructor & Destructor Documentation

MapCheckerT::MapCheckerT ( MapDocumentT &  MapDoc, IntrusivePtrT< CompMapEntityT >  Ent  )

inline

The constructor.

virtual MapCheckerT::~MapCheckerT ( )

inlinevirtual

The virtual destructor.

Member Function Documentation

virtual bool MapCheckerT::CanFix ( ) const

inlinevirtual

Returns whether this checker is able to provide a fix the problem (some problems can only be detected, but not fixed).

IntrusivePtrT<CompMapEntityT> MapCheckerT::GetEnt ( ) const

inline

Returns the entity that this checker is assigned to.

virtual CommandT* MapCheckerT::GetFix ( ) const

inlinevirtual

Returns a command that fixes the problem, if possible (that is, when HasProblem() and CanFix() returns true). Returns NULL otherwise.

virtual wxString MapCheckerT::GetHelpText ( ) const

inlinevirtual

Returns a longer help text about the details of the problem and how it can be fixed.

Reimplemented in MC_WorldHasPlayerPrototypeT, and MC_WorldHasPlayerStartT.

virtual wxString MapCheckerT::GetInfo ( ) const

inlinevirtual

Returns a brief information about the nature of the problem.

Reimplemented in MC_WorldHasPlayerPrototypeT, and MC_WorldHasPlayerStartT.

virtual bool MapCheckerT::HasProblem ( ) const

inlinevirtual

Returns whether this map checker has actually identified a problem with the entity it is assigned to.

When false, there either never was a problem in the first place, or it has been fixed already.

Reimplemented in MC_WorldHasPlayerPrototypeT, and MC_WorldHasPlayerStartT.

---

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

• CaWE/MapEditor/DialogMapCheck.cpp