UserWise LiveOps in-game file/media variable. More...

Inheritance diagram for UserWiseSDK.Variables.Types.FileVariable:

Public Member Functions
	FileVariable (string name, string defaultValue)

void	GetRawFileData (Action< bool, byte[]> handler)
	Acts as a shortcut for calling `UserWise.INSTANCE.GetRawDataFromMediaId`. More...

override void	UpdateValueFromAPI (object newValue)
	Attempts to update the CurrentValue with the provided, abstract, newValue through proper type conversion. More...

Public Member Functions inherited from UserWiseSDK.Variables.Types.Variable< string >
virtual string	GetName ()
	Getter access for the Name field. More...

virtual object	GetDefaultValue ()
	Getter access for a formatted variant of the DefaultValue. Overridden in some variable types. More...

virtual object	GetValueForCache ()
	Overridable method used for retrieving the CurrentValue as a cacheable value. More...

virtual void	SetValueFromCache (object newValue)
	Acts as an overridable path for variable types that need to do different things during the set value from cache, that would not happen in UpdateValueFromAPI(object). More...

virtual void	ResetToDefault ()
	Results the CurrentValue to the DefaultValue More...

T	GetCurrentOrDefaultValue ()
	Returns the CurrentValue, if present, otherwise returns the DefaultValue. More...

void	SetCurrentValue (T newValue)
	Sets the CurrentValue to the provided `newValue`. Also emits the OnValueChange event. More...

string	GetLowercaseVariableType ()
	Retrieves the Type (VariableType enum value) as a lowercase format string that the API-layer can ingest. More...

Additional Inherited Members
Public Attributes inherited from UserWiseSDK.Variables.Types.Variable< string >
readonly string	Name

readonly T	DefaultValue

Properties inherited from UserWiseSDK.Variables.Types.Variable< string >
T	CurrentValue `[get, protected set]`
	The current value of the Variable; in abstract typing. CurrentValue can be null, if there is no override. Generally, accessing the underlying value is done through `GetCurrentOrDefaultValue()`. More...

Events inherited from UserWiseSDK.Variables.Types.Variable< string >
EventHandler< OnValueChangeEventArgs >	OnValueChange

Detailed Description

UserWise LiveOps in-game file/media variable.

The value stored within is the ID of the media on the UserWise servers.

Member Function Documentation

void UserWiseSDK.Variables.Types.FileVariable.GetRawFileData ( Action< bool, byte[]> handler )

inline

Acts as a shortcut for calling UserWise.INSTANCE.GetRawDataFromMediaId.

Parameters

handler bool is a success indicator; byte[] is the data, if present.

override void UserWiseSDK.Variables.Types.FileVariable.UpdateValueFromAPI ( object newValue )

inlinevirtual

Attempts to update the CurrentValue with the provided, abstract, newValue through proper type conversion.

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