Panda3D
|
This is a generic, untyped ConfigVariable. More...
#include <pandadoc.hpp>
Public Member Functions | |
__init__ (const ConfigVariable) | |
__init__ (str name) | |
Use this constructor to make a ConfigVariable of an unspecified type. | |
clearValue () | |
Removes the value assigned to this variable, and lets its original value (as read from the prc files) show through. | |
int | getNumWords () |
Returns the number of words in the variable's value. | |
str | getStringValue () |
Returns the toplevel value of the variable, formatted as a string. | |
setStringValue (str value) | |
Changes the value assigned to this variable. | |
![]() | |
bool | clearLocalValue () |
Removes the local value defined for this variable, and allows its value to be once again retrieved from the .prc files. | |
str | getDescription () |
Returns the brief description of this variable, if it has been defined. | |
int | getFlags () |
Returns the flags value as set by set_flags(). | |
str | getName () |
Returns the name of the variable. | |
int | getTrustLevel () |
Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable. | |
ConfigFlags::ValueType | getValueType () |
Returns the stated type of this variable. | |
bool | hasLocalValue () |
Returns true if this variable's value has been shadowed by a local assignment (as created via make_local_value()), or false otherwise. | |
bool | hasValue () |
Returns true if this variable has an explicit value, either from a prc file or locally set, or false if variable has its default value. | |
bool | isClosed () |
Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()). | |
bool | isDynamic () |
Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables. | |
output (Ostream out) | |
write (Ostream out) | |
![]() | |
__init__ () | |
__init__ (const ConfigFlags) | |
Additional Inherited Members | |
![]() | |
enum | ValueType { VT_undefined = 0 , VT_list = 1 , VT_string = 2 , VT_filename = 3 , VT_bool = 4 , VT_int = 5 , VT_double = 6 , VT_enum = 7 , VT_search_path = 8 , VT_int64 = 9 , VT_color = 10 } |
enum | VariableFlags { F_trust_level_mask = 4095 , F_open = 4096 , F_closed = 8192 , F_dynamic = 16384 , F_dconfig = 32768 } |
![]() | |
bool | closed |
Returns true if the variable is not trusted by any prc file (and hence cannot be modified from its compiled-in default value), or false for the normal case, in which the variable can be modified by any prc file at or above its trust level (see get_trust_level()). | |
const String | description |
Returns the brief description of this variable, if it has been defined. | |
bool | dynamic |
Returns true if the variable was indicated as "dynamic" by its constructor, indicating that its name was dynamically generated, possibly from a large pool, and it should not be listed along with the other variables. | |
const String | name |
Returns the name of the variable. | |
int | trust_level |
Returns the minimum trust_level a prc file must demonstrate in order to redefine the value for this variable. | |
ConfigFlags::ValueType | value_type |
Returns the stated type of this variable. | |
This is a generic, untyped ConfigVariable.
It is also the base class for the typed ConfigVariables, and contains all of the code common to ConfigVariables of all types (except ConfigVariableList, which is a bit of a special case).
Mostly, this class serves as a thin wrapper around ConfigVariableCore and/or ConfigDeclaration, more or less duplicating the interface presented there.
__init__ | ( | const ConfigVariable | ) |
__init__ | ( | str | name | ) |
Use this constructor to make a ConfigVariable of an unspecified type.
Usually you'd want to do this just to reference a previously-defined ConfigVariable of a specific type, without having to know what type it is.
clearValue | ( | ) |
Removes the value assigned to this variable, and lets its original value (as read from the prc files) show through.
int getNumWords | ( | ) |
Returns the number of words in the variable's value.
A word is defined as a sequence of non-whitespace characters delimited by whitespace.
str getStringValue | ( | ) |
Returns the toplevel value of the variable, formatted as a string.
setStringValue | ( | str | value | ) |
Changes the value assigned to this variable.
This creates a local value that shadows any values defined in the .prc files, until clear_local_value() is called.