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 AYomPortal *	OpenRandomYomPortalInWorld (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 AYomPortal *	GetRandomAvailableYomPortal (UObject *pWorldContextObject)
	Gets a random portal from the world. More...
static AYomPortal *	GetYomPortalFromID (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

pPortal

The portal to close

GetRandomAvailableYomPortal()

AYomPortal * UYomPortalsBPFunctions::GetRandomAvailableYomPortal ( UObject *  pWorldContextObject )

static

Gets a random portal from the world.

Parameters

pWorldContextObject

An 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

pWorldContextObject	An object of the world (is set by unreal)
pPortalID	The portalID

Returns

The transform of the the portal

GetYomPortalFromID()

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

static

Gets a portal from an ID.

Parameters

pWorldContextObject	An object of the world (is set by unreal)
pPortalID	The 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

pPlayer	The player that opens the portal
pUrl	The 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

pWorld	The world to open the portal in
pUrl	The 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

pPortal	The portal to open
pUrl	The url to portal to