App::Property class
#include <Spore ModAPI/Spore/App/Property.h>

Property is a class used to represent a property belonging to a PROP file.

This class is widely used for configuring and storing game properties. The class PropertyList is used to group properties together, and represent a PROP file.

This class is not usually used directly; it provides, however, numerous static methods to easily get data from a PropertyList. For example, to get a property from a PROP file:

PropertyList* propList = ...;  // get the PropertyList, probably from the PropManager class
float modelScale = 1.0f;  // we can assign it a default value
Property::GetFloat(propList, 0x00FBA611, modelScale);  // 0x00FBA611 is the propertyID of modelScale; you can find them in reg_property.txt (SporeMaster/SporeModder)
// this returns a bool; if you don't assign default values, it might be a good idea to check it

Another use of this class is to assign values; this can be used to store saved game data, for example:

// assuming the propertyID is just the hash of 'dnaAmount' (so it does not have an entry on reg_property.txt)
propList->AddProperty(Hash::FNV("dnaAmount"), Property().SetValueInt32(80));

Public types

struct TextProperty
enum PropertyFlags { kPropertyFlagNotDirect = 0x10, kPropertyFlagArray = 0x30 }

Constructors, destructors, conversion operators

Property()
Property(const Property&)
~Property()

Public variables

short mnFlags
PropertyType mnType

Protected functions

auto Clear(bool arg_0) -> void
auto UNNAMED(PropertyValues) -> union

Methods for getting value pointers

auto GetValueInt32() -> int32_t*: Returns a pointer to the int32_t value(s) of this property.
auto GetValueFloat() -> float*: Returns a pointer to the float value(s) of this property.
auto GetValueBool() -> bool*: Returns a pointer to the bool value(s) of this property.
auto GetValueUInt32() -> uint32_t*: Returns a pointer to the uint32_t value(s) of this property.
auto GetValueVector2() -> Vector2*: Returns a pointer to the Math::Vector2 value(s) of this property.
auto GetValueVector3() -> Vector3*: Returns a pointer to the Math::Vector3 value(s) of this property.
auto GetValueVector4() -> Vector4*: Returns a pointer to the Math::Vector4 value(s) of this property.
auto GetValueColorRGB() -> ColorRGB*: Returns a pointer to the Math::ColorRGB value(s) of this property.
auto GetValueColorRGBA() -> ColorRGBA*: Returns a pointer to the Math::ColorRGBA value(s) of this property.
auto GetValueKey() -> ResourceKey*: Returns a pointer to the ResourceKey ('key') value(s) of this property.
auto GetValueTransform() -> Transform*: Returns a pointer to the EntityTransform ('transform') value(s) of this property.
auto GetValueText() -> LocalizedString*: Returns a pointer to the LocalizedString ('text') value(s) of this property.
auto GetValueBBox() -> BoundingBox*: Returns a pointer to the BoundingBox ('bbox') value(s) of this property.
auto GetValueString8() -> eastl::string8*: Returns a pointer to the eastl::string8 value(s) of this property.
auto GetValueString16() -> eastl::string16*: Returns a pointer to the eastl::string16 value(s) of this property.
auto GetValueChar() -> char*: Returns a pointer to the char value(s) of this property.
auto GetValueWChar() -> char16_t*: Returns a pointer to the char16_t value(s) of this property.
auto GetValueInt8() -> int8_t*: Returns a pointer to the int8_t value(s) of this property.
auto GetValueUInt8() -> uint8_t*: Returns a pointer to the uint8_t value(s) of this property.
auto GetValueInt16() -> int16_t*: Returns a pointer to the int16_t value(s) of this property.
auto GetValueUInt16() -> uint16_t*: Returns a pointer to the uint16_t value(s) of this property.
auto GetValueInt64() -> int64_t*: Returns a pointer to the int64_t value(s) of this property.
auto GetValueUInt64() -> uint64_t*: Returns a pointer to the uint64_t value(s) of this property.
auto GetValueDouble() -> double*: Returns a pointer to the double value(s) of this property.
auto GetValueFlags() -> void**: Returns a pointer to the 'flags' value(s) of this property.
auto GetValue() -> void*: Returns a pointer to the value(s) of this property, regardless of its type.

Methods for setting values

auto Set(PropertyType type, int flags, void* pValue, size_t nValueSize, size_t nValueCount) -> bool: Sets the value of this property.
auto SetValueBool(const bool& value) -> Property&: Sets the value of this Property to the given bool value.
auto SetValueInt32(const int32_t& value) -> Property&: Sets the value of this Property to the given int32_t value.
auto SetValueUInt32(const uint32_t& value) -> Property&: Sets the value of this Property to the given uint32_t value.
auto SetValueFloat(const float& value) -> Property&: Sets the value of this Property to the given float value.
auto SetValueKey(const ResourceKey& value) -> Property&: Sets the value of this Property to the given ResourceKey value.
auto SetValueString8(const eastl::string8& value) -> Property&: Sets the value of this Property to the given eastl::string8 value.
auto SetValueString16(const eastl::string16& value) -> Property&: Sets the value of this Property to the given eastl::string16 value.
auto SetValueBBox(const BoundingBox& value) -> Property&: Sets the value of this Property to the given BoundingBox value.
auto SetValueVector2(const Vector2& value) -> Property&: Sets the value of this Property to the given Math::Vector2 value.
auto SetValueVector3(const Vector3& value) -> Property&: Sets the value of this Property to the given Math::Vector3 value.
auto SetValueVector4(const Vector4& value) -> Property&: Sets the value of this Property to the given Math::Vector4 value.
auto SetValueColorRGB(const ColorRGB& value) -> Property&: Sets the value of this Property to the given Math::ColorRGB value.
auto SetValueColorRGBA(const ColorRGBA& value) -> Property&: Sets the value of this Property to the given Math::ColorRGBA value.
auto SetArrayBool(const bool* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of bool values.
auto SetArrayInt32(const int32_t* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of int32_t values.
auto SetArrayUInt32(const uint32_t* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of uint32_t values.
auto SetArrayFloat(const float* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of float values.
auto SetArrayKey(const ResourceKey* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of ResourceKey values.
auto SetArrayString8(const eastl::string8* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to the an array of eastl::string8 values.
auto SetArrayString16(const eastl::string16* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of eastl::string16 values.
auto SetArrayBBox(const BoundingBox* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of BoundingBox values.
auto SetArrayTransform(const Transform* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of Transform values.
auto SetArrayText(const LocalizedString* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of LocalizedString values.
auto SetArrayVector2(const Vector2* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of Math::Vector2 values.
auto SetArrayVector3(const Vector3* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of Math::Vector3 values.
auto SetArrayVector4(const Vector4* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of Math::Vector4 values.
auto SetArrayColorRGB(const ColorRGB* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of Math::ColorRGB values.
auto SetArrayColorRGBA(const ColorRGBA* pValues, size_t nValueCount) -> Property&: Sets the value of this Property to an array of Math::ColorRGBA values.

Static methods for getting values

static auto GetBool(const PropertyList* pPropertyList, uint32_t propertyID, bool& dst) -> bool: Gets a single bool value from a property with the propertyID specified in the given list.
static auto GetFloat(const PropertyList* pPropertyList, uint32_t propertyID, float& dst) -> bool: Gets a single float value from a property with the propertyID specified in the given list.
static auto GetInt32(const PropertyList* pPropertyList, uint32_t propertyID, int32_t& dst) -> bool: Gets a single int32_t value from a property with the propertyID specified in the given list.
static auto GetUInt32(const PropertyList* pPropertyList, uint32_t propertyID, uint32_t& dst) -> bool: Gets a single uint32_t value from a property with the propertyID specified in the given list.
static auto GetVector2(const PropertyList* pPropertyList, uint32_t propertyID, Vector2& dst) -> bool: Gets a single Math::Vector2 value from a property with the propertyID specified in the given list.
static auto GetVector3(const PropertyList* pPropertyList, uint32_t propertyID, Vector3& dst) -> bool: Gets a single Math::Vector3 value from a property with the propertyID specified in the given list.
static auto GetVector4(const PropertyList* pPropertyList, uint32_t propertyID, Vector4& dst) -> bool: Gets a single Meth::Vector4 value from a property with the propertyID specified in the given list.
static auto GetColorRGB(const PropertyList* pPropertyList, uint32_t propertyID, ColorRGB& dst) -> bool: Gets a single Meth::ColorRGB value from a property with the propertyID specified in the given list.
static auto GetColorRGBA(const PropertyList* pPropertyList, uint32_t propertyID, ColorRGBA& dst) -> bool: Gets a single Math::ColorRGBA value from a property with the propertyID specified in the given list.
static auto GetKey(const PropertyList* pPropertyList, uint32_t propertyID, ResourceKey& dst) -> bool: Gets a single ResourceKey value from a property with the propertyID specified in the given list.
static auto GetKeyInstanceID(const PropertyList* pPropertyList, uint32_t propertyID, uint32_t& dst) -> bool: Gets the instanceID of a single ResourceKey value from a property with the propertyID specified in the given list.
static auto GetKeyGroupID(const PropertyList* pPropertyList, uint32_t propertyID, uint32_t& dst) -> bool: Gets the groupID of a single ResourceKey value from a property with the propertyID specified in the given list.
static auto GetKeyTypeID(const PropertyList* pPropertyList, uint32_t propertyID, uint32_t& dst) -> bool: Gets the typeID of a single ResourceKey value from a property with the propertyID specified in the given list.
static auto GetText(const PropertyList* pPropertyList, uint32_t propertyID, LocalizedString& dst) -> bool: Gets a single LocalizedString ('text') value from a property with the propertyID specified in the given list.
static auto GetCString8(const PropertyList* pPropertyList, uint32_t propertyID, char*& dst) -> bool: Gets a single char* ('eastl::string8') value from a property with the propertyID specified in the given list.
static auto GetCString16(const PropertyList* pPropertyList, uint32_t propertyID, char16_t*& dst) -> bool: Gets a single char16_t* ('eastl::string16') value from a property with the propertyID specified in the given list.
static auto GetString8(const PropertyList* pPropertyList, uint32_t propertyID, eastl::string& dst) -> bool: Gets a single eastl::string8 value from a property with the propertyID specified in the given list.
static auto GetString16(const PropertyList* pPropertyList, uint32_t propertyID, eastl::string16& dst) -> bool: Gets a single eastl::string16 value from a property with the propertyID specified in the given list.
static auto GetArrayBool(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, bool*& dst) -> bool: Gets an array of bool values from a property with the propertyID specified in the given list.
static auto GetArrayInt32(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, int*& dst) -> bool: Gets an array of int32_t values from a property with the propertyID specified in the given list.
static auto GetArrayUInt32(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, unsigned int*& dst) -> bool: Gets an array of uint32_t values from a property with the propertyID specified in the given list.
static auto GetArrayFloat(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, float*& dst) -> bool: Gets an array of float values from a property with the propertyID specified in the given list.
static auto GetArrayVector2(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, Vector2*& dst) -> bool: Gets an array of Math::Vector2 values from a property with the propertyID specified in the given list.
static auto GetArrayVector3(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, Vector3*& dst) -> bool: Gets an array of Math::Vector3 values from a property with the propertyID specified in the given list.
static auto GetArrayVector4(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, Vector4*& dst) -> bool: Gets an array of Math::Vector4 values from a property with the propertyID specified in the given list.
static auto GetArrayColorRGB(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, ColorRGB*& dst) -> bool: Gets an array of Math::ColorRGB values from a property with the propertyID specified in the given list.
static auto GetArrayKey(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, ResourceKey*& dst) -> bool: Gets an array of ResourceKey values from a property with the propertyID specified in the given list.
static auto GetArrayString8(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, eastl::string8*& dst) -> bool: Gets an array of char* ('eastl::string8') values from a property with the propertyID specified in the given list.
static auto GetArrayString16(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, eastl::string16*& dst) -> bool: Gets an array of 'eastl::string16' values from a property with the propertyID specified in the given list.
static auto GetArrayTransform(const PropertyList* pPropertyList, uint32_t propertyID, size_t& dstCount, Transform*& dst) -> bool: Gets an array of EntityTransform values from a property with the propertyID specified in the given list.