ConfigVariableBase

from panda3d.core import ConfigVariableBase
class ConfigVariableBase

Bases: ConfigFlags

This class is the base class for both ConfigVariableList and ConfigVariable (and hence for all of the ConfigVariableBool, ConfigVaribleString, etc. classes). It collects together the common interface for all generic ConfigVariables.

Mostly, this class serves as a thin wrapper around ConfigVariableCore and/or ConfigDeclaration, more or less duplicating the interface presented there.

Inheritance diagram

Inheritance diagram of ConfigVariableBase

__init__(*args, **kwargs)
clearLocalValue()

C++ Interface: clear_local_value(const ConfigVariableBase self)

/**

  • Removes the local value defined for this variable, and allows its value to

  • be once again retrieved from the .prc files.

  • Returns true if the value was successfully removed, false if it did not

  • exist in the first place.

*/

clear_local_value()

C++ Interface: clear_local_value(const ConfigVariableBase self)

/**

  • Removes the local value defined for this variable, and allows its value to

  • be once again retrieved from the .prc files.

  • Returns true if the value was successfully removed, false if it did not

  • exist in the first place.

*/

closed
description
dynamic
getDescription()

C++ Interface: get_description(ConfigVariableBase self)

/**

  • Returns the brief description of this variable, if it has been defined.

*/

getFlags()

C++ Interface: get_flags(ConfigVariableBase self)

/**

  • Returns the flags value as set by set_flags(). This includes the trust

  • level and some other settings. See the individual methods is_closed(),

  • get_trust_level(), etc. to pull out the semantic meaning of these flags

  • individually.

*/

getName()

C++ Interface: get_name(ConfigVariableBase self)

/**

  • Returns the name of the variable.

*/

getTrustLevel()

C++ Interface: get_trust_level(ConfigVariableBase self)

/**

  • Returns the minimum trust_level a prc file must demonstrate in order to

  • redefine the value for this variable. Arguably, this should be called the

  • “mistrust level”, since the larger the value, the more suspicious we are of

  • prc files. This value is not used if is_closed() returns true, which

  • indicates no file may be trusted.

  • This value only has effect in a release build (specifically, when

  • PRC_RESPECT_TRUST_LEVEL is defined true in Config.pp).

*/

getValueType()

C++ Interface: get_value_type(ConfigVariableBase self)

/**

  • Returns the stated type of this variable. This should be VT_list, unless a

  • later variable declaration has changed it.

*/

get_description()

C++ Interface: get_description(ConfigVariableBase self)

/**

  • Returns the brief description of this variable, if it has been defined.

*/

get_flags()

C++ Interface: get_flags(ConfigVariableBase self)

/**

  • Returns the flags value as set by set_flags(). This includes the trust

  • level and some other settings. See the individual methods is_closed(),

  • get_trust_level(), etc. to pull out the semantic meaning of these flags

  • individually.

*/

get_name()

C++ Interface: get_name(ConfigVariableBase self)

/**

  • Returns the name of the variable.

*/

get_trust_level()

C++ Interface: get_trust_level(ConfigVariableBase self)

/**

  • Returns the minimum trust_level a prc file must demonstrate in order to

  • redefine the value for this variable. Arguably, this should be called the

  • “mistrust level”, since the larger the value, the more suspicious we are of

  • prc files. This value is not used if is_closed() returns true, which

  • indicates no file may be trusted.

  • This value only has effect in a release build (specifically, when

  • PRC_RESPECT_TRUST_LEVEL is defined true in Config.pp).

*/

get_value_type()

C++ Interface: get_value_type(ConfigVariableBase self)

/**

  • Returns the stated type of this variable. This should be VT_list, unless a

  • later variable declaration has changed it.

*/

hasLocalValue()

C++ Interface: has_local_value(ConfigVariableBase self)

/**

  • Returns true if this variable’s value has been shadowed by a local

  • assignment (as created via make_local_value()), or false otherwise.

*/

hasValue()

C++ Interface: has_value(ConfigVariableBase self)

/**

  • 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.

*/

has_local_value()

C++ Interface: has_local_value(ConfigVariableBase self)

/**

  • Returns true if this variable’s value has been shadowed by a local

  • assignment (as created via make_local_value()), or false otherwise.

*/

has_value()

C++ Interface: has_value(ConfigVariableBase self)

/**

  • 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.

*/

isClosed()

C++ Interface: is_closed(ConfigVariableBase self)

/**

  • 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()).

  • This value only has effect in a release build (specifically, when

  • PRC_RESPECT_TRUST_LEVEL is defined true in Config.pp).

*/

isDynamic()

C++ Interface: is_dynamic(ConfigVariableBase self)

/**

  • 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.

*/

is_closed()

C++ Interface: is_closed(ConfigVariableBase self)

/**

  • 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()).

  • This value only has effect in a release build (specifically, when

  • PRC_RESPECT_TRUST_LEVEL is defined true in Config.pp).

*/

is_dynamic()

C++ Interface: is_dynamic(ConfigVariableBase self)

/**

  • 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.

*/

name
output()

C++ Interface: output(ConfigVariableBase self, ostream out)

/**

*/

trust_level
upcastToConfigFlags()

C++ Interface: upcast_to_ConfigFlags(const ConfigVariableBase self)

upcast from ConfigVariableBase to ConfigFlags

upcast_to_ConfigFlags()

C++ Interface: upcast_to_ConfigFlags(const ConfigVariableBase self)

upcast from ConfigVariableBase to ConfigFlags

value_type
write()

C++ Interface: write(ConfigVariableBase self, ostream out)

/**

*/