YOM Replicator SDK 0.8.0.0
A metaverse SDK created by YOM
Loading...
Searching...
No Matches
UYomCoreBPFunctions Class Reference

Detailed Description

A BlueprintFunctionLibrary for YomCore.

Inheritance diagram for UYomCoreBPFunctions:

Static Public Member Functions

Blueprint Functions
static AYomPlayerGetYomPlayerFromActor (AActor *pActor)
 Tries to retrieve the owning YomPlayer from an actor. More...
 
static AYomPlayerGetYomPlayer (const UObject *pWorldContextObject)
 Gets a YomPlayer. More...
 
static FString GetBlockchainFromWalletType (const EWalletType &pType)
 Gets the blockchain type as an FString. More...
 
static FString ConvertVaRestJsonToString (UVaRestJsonObject *pJson)
 Converts a VaRest JSON to an FString. More...
 
static void CallSigFunction (const AYomPlayer *pPlayer, const FString &pFunction, const TArray< FString > &pVariableNames, const TArray< UVaRestJsonValue * > &pVariableValues)
 Calls a function on the signalling server. More...
 
static void RedirectPlayer (const AYomPlayer *pPlayer, const FString &pUrl)
 Redirects a player to a different page. More...
 
static FString GetYourOpenMetaversePluginVersion ()
 Gets the plugin version of YourOpenMetaverse. More...
 
static UVaRestSubsystem * GetVaRestSubsystem ()
 Returns the varest subsystem used in this function library. More...
 

Member Function Documentation

◆ CallSigFunction()

void UYomCoreBPFunctions::CallSigFunction ( const AYomPlayer pPlayer,
const FString &  pFunction,
const TArray< FString > &  pVariableNames,
const TArray< UVaRestJsonValue * > &  pVariableValues 
)
static

Calls a function on the signalling server.

Parameters
pPlayerThe player to call the function on
pFunctionThe function that needs to be called
pVariableNamesThe names of all the variables of the function
pVariableValuesThe values of all the variables of the function

◆ ConvertVaRestJsonToString()

FString UYomCoreBPFunctions::ConvertVaRestJsonToString ( UVaRestJsonObject *  pJson)
static

Converts a VaRest JSON to an FString.

Parameters
pJsonThe JSON that needs to be converted
Returns
A string that contains the JSON

◆ GetBlockchainFromWalletType()

FString UYomCoreBPFunctions::GetBlockchainFromWalletType ( const EWalletType pType)
static

Gets the blockchain type as an FString.

Parameters
pTypeThe type that needs to be converted to an FString
Returns
The FString of the type

◆ GetVaRestSubsystem()

UVaRestSubsystem * UYomCoreBPFunctions::GetVaRestSubsystem ( )
static

Returns the varest subsystem used in this function library.

◆ GetYomPlayer()

AYomPlayer * UYomCoreBPFunctions::GetYomPlayer ( const UObject *  pWorldContextObject)
static

Gets a YomPlayer.

Parameters
pWorldContextObjectThe context object (should be given by unreal)
Returns
The current YomPlayer

◆ GetYomPlayerFromActor()

AYomPlayer * UYomCoreBPFunctions::GetYomPlayerFromActor ( AActor *  pActor)
static

Tries to retrieve the owning YomPlayer from an actor.

Parameters
pActorThe actor that has a relation to a YomPlayer
Returns
If found the YomPlayer, if not it will return a nullptr

◆ GetYourOpenMetaversePluginVersion()

FString UYomCoreBPFunctions::GetYourOpenMetaversePluginVersion ( )
static

Gets the plugin version of YourOpenMetaverse.

◆ RedirectPlayer()

void UYomCoreBPFunctions::RedirectPlayer ( const AYomPlayer pPlayer,
const FString &  pUrl 
)
static

Redirects a player to a different page.

Parameters
pPlayerThe player that needs to be redirected
pUrlThe url to redirect to