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

Detailed Description

A BlueprintFunctionLibrary for the Portals system.

Inheritance diagram for UYomPortalsBPFunctions:

Static Public Member Functions

static void OpenRandomYomPortalFromPlayer (AYomPlayer *pPlayer, const FString &pUrl)
 Opens a random portal in the world of the player to the url. More...
 
static AYomPortalOpenRandomYomPortalInWorld (AYomPlayer *pPlayer, UWorld *pWorld, const FString &pUrl)
 Opens a random portal in the world to the url. More...
 
static void OpenYomPortal (AYomPlayer *pPlayer, AYomPortal *pPortal, const FString &pUrl)
 Opens a portal in the world to the url. More...
 
static void CloseYomPortal (AYomPlayer *pPlayer, AYomPortal *pPortal)
 Closes the portal. More...
 
static AYomPortalGetRandomAvailableYomPortal (UObject *pWorldContextObject)
 Gets a random portal from the world. More...
 
static AYomPortalGetYomPortalFromID (UObject *pWorldContextObject, int pPortalID)
 Gets a portal from an ID. More...
 
static FTransform GetTransformFromPortalID (UObject *pWorldContextObject, int pPortalID)
 Gets the transform from a portalID. More...
 

Member Function Documentation

◆ CloseYomPortal()

void UYomPortalsBPFunctions::CloseYomPortal ( AYomPlayer pPlayer,
AYomPortal pPortal 
)
static

Closes the portal.

Parameters
pPortalThe portal to close

◆ GetRandomAvailableYomPortal()

AYomPortal * UYomPortalsBPFunctions::GetRandomAvailableYomPortal ( UObject *  pWorldContextObject)
static

Gets a random portal from the world.

Parameters
pWorldContextObjectAn object of the world (is set by unreal)
Returns
A random portal

◆ GetTransformFromPortalID()

FTransform UYomPortalsBPFunctions::GetTransformFromPortalID ( UObject *  pWorldContextObject,
int  pPortalID 
)
static

Gets the transform from a portalID.

Parameters
pWorldContextObjectAn object of the world (is set by unreal)
pPortalIDThe portalID
Returns
The transform of the the portal

◆ GetYomPortalFromID()

AYomPortal * UYomPortalsBPFunctions::GetYomPortalFromID ( UObject *  pWorldContextObject,
int  pPortalID 
)
static

Gets a portal from an ID.

Parameters
pWorldContextObjectAn object of the world (is set by unreal)
pPortalIDThe ID
Returns
The portal with the given ID

◆ OpenRandomYomPortalFromPlayer()

void UYomPortalsBPFunctions::OpenRandomYomPortalFromPlayer ( AYomPlayer pPlayer,
const FString &  pUrl 
)
static

Opens a random portal in the world of the player to the url.

Parameters
pPlayerThe player that opens the portal
pUrlThe url of the other world

◆ OpenRandomYomPortalInWorld()

AYomPortal * UYomPortalsBPFunctions::OpenRandomYomPortalInWorld ( AYomPlayer pPlayer,
UWorld *  pWorld,
const FString &  pUrl 
)
static

Opens a random portal in the world to the url.

Parameters
pWorldThe world to open the portal in
pUrlThe url of the other world

◆ OpenYomPortal()

void UYomPortalsBPFunctions::OpenYomPortal ( AYomPlayer pPlayer,
AYomPortal pPortal,
const FString &  pUrl 
)
static

Opens a portal in the world to the url.

Parameters
pPortalThe portal to open
pUrlThe url to portal to