Phosphorus::StringParameter Class Reference

String based parameter. More...

#include <GameObject.h>

Inheritance diagram for Phosphorus::StringParameter:

Collaboration diagram for Phosphorus::StringParameter:

Public Member Functions
	StringParameter (const String &name, const String &defaultValue)
int32	Write (nlohmann::json &target) const override
	Writes text representation of data to JSON object.
int32	Read (nlohmann::json &target) override
	Parses text representation of data from JSON object.
Public Member Functions inherited from Phosphorus::IParameter< String >
	IParameter (const String &name, const String &defaultValue)
void	SetValue (const String &value)
	Sets value.
String	GetValue () const
	Returns value.
void	SetDisplayName (const String &name) override
String	GetName () const override
	Returns parameter name.
String	GetDisplayName () const override
	Returns parameter display name.

Additional Inherited Members
Protected Attributes inherited from Phosphorus::IParameter< String >
String	m_Value
String	m_Name
String	m_DisplayName

Detailed Description

String based parameter.

Member Function Documentation

Read()

int32 Phosphorus::StringParameter::Read ( nlohmann::json & target )

inlineoverridevirtual

Parses text representation of data from JSON object.

Parameters

target

JSON object

Returns

int32 Bytes written

Implements Phosphorus::IBaseParameter.

Write()

int32 Phosphorus::StringParameter::Write ( nlohmann::json & target ) const

inlineoverridevirtual

Writes text representation of data to JSON object.

Parameters

target

JSON object

Returns

int32 Bytes written

Implements Phosphorus::IBaseParameter.

---

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

• phosphorus/GameObject.h