Coherent UI for Unreal Engine 4  2.5.5.0
A modern user interface library for games
 All Classes Functions Variables Pages
UCoherentUIJSPayload Class Reference

#include <CoherentUIJSPayload.h>

Inherits UObject.

Public Member Functions

FString GetString (int32 index)
 
int32 GetInt32 (int32 index)
 
uint32 GetUInt32 (int32 index)
 
bool GetBool (int32 index)
 
float GetNumber (int32 index)
 
void ReadObject (int32 index, UObject *object)
 

Public Attributes

FString EventName
 

Detailed Description

The class represents data passed by JavaScript to the application. Use this class to unpach parameters passed from JavaScript to the application.

Member Function Documentation

bool UCoherentUIJSPayload::GetBool ( int32  index)

Gets a Boolean parameter passed from JavaScript

Parameters
indexthe index of the parameter
int32 UCoherentUIJSPayload::GetInt32 ( int32  index)

Gets an Integer parameter passed from JavaScript

Parameters
indexthe index of the parameter
float UCoherentUIJSPayload::GetNumber ( int32  index)

Gets a Float parameter passed from JavaScript

Parameters
indexthe index of the parameter
FString UCoherentUIJSPayload::GetString ( int32  index)

Gets a String parameter passed from JavaScript

Parameters
indexthe index of the parameter
uint32 UCoherentUIJSPayload::GetUInt32 ( int32  index)

Gets an Unsigned Integer parameter passed from JavaScript

Parameters
indexthe index of the parameter
void UCoherentUIJSPayload::ReadObject ( int32  index,
UObject *  object 
)

Reads an Object passed from JavaScript and updates the properties of the UObject passed. All properties that have the same name and compatible type will be updated.

Parameters
indexthe index of the parameter
objectthe object whose properties to update

Member Data Documentation

FString UCoherentUIJSPayload::EventName

The name of the event triggered from JavaScript