Isle
Loading...
Searching...
No Matches
VisibilityVariable Class Reference

[AI] Variable to trigger show/hide operations on in-game 3D objects (ROIs) by parsing visibility commands. More...

#include <legovariables.h>

Inheritance diagram for VisibilityVariable:
Collaboration diagram for VisibilityVariable:

Public Member Functions

 VisibilityVariable ()
 [AI] Initializes the VisibilityVariable and sets its key to g_varVISIBILITY. [AI] More...
 
void SetValue (const char *p_value) override
 [AI] Sets the value of this variable and, if the value encodes a valid visibility instruction, parses and applies the show/hide operation to the target ROI. More...
 
- Public Member Functions inherited from MxVariable
 MxVariable ()
 [AI] Constructs an empty variable with no key or value. More...
 
 MxVariable (const char *p_key, const char *p_value)
 [AI] Constructs a variable with the specified key and value. More...
 
 MxVariable (const char *p_key)
 [AI] Constructs a variable with the specified key and no value. More...
 
virtual MxStringGetValue ()
 [AI] Retrieves a pointer to the variable's value. More...
 
virtual void SetValue (const char *p_value)
 [AI] Sets the variable's value. More...
 
virtual void Destroy ()
 [AI] Destroys the variable, deleting the object. More...
 
const MxStringGetKey () const
 [AI] Provides read-only access to the variable's key/name. More...
 

Additional Inherited Members

- Protected Attributes inherited from MxVariable
MxString m_key
 [AI] The variable's key (name), always stored in uppercase. More...
 
MxString m_value
 [AI] The variable's value. More...
 

Detailed Description

[AI] Variable to trigger show/hide operations on in-game 3D objects (ROIs) by parsing visibility commands.

[AI] This variable parses commands in the format "SHOW <ROI_NAME>" or "HIDE <ROI_NAME>", finds the corresponding ROI, and sets its visibility. Inherits from MxVariable. The variable key is automatically set to g_varVISIBILITY.

Definition at line 66 of file legovariables.h.

Constructor & Destructor Documentation

◆ VisibilityVariable()

VisibilityVariable::VisibilityVariable ( )
inline

[AI] Initializes the VisibilityVariable and sets its key to g_varVISIBILITY. [AI]

Definition at line 69 of file legovariables.h.

Member Function Documentation

◆ SetValue()

void VisibilityVariable::SetValue ( const char *  p_value)
overridevirtual

[AI] Sets the value of this variable and, if the value encodes a valid visibility instruction, parses and applies the show/hide operation to the target ROI.

[AI]

Parameters
p_valueThe new value, in the format "SHOW <ROI_NAME>" or "HIDE <ROI_NAME>". [AI]

Reimplemented from MxVariable.

Definition at line 105 of file legovariables.cpp.


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