Detailed Description
A portal that can portal players to a different metaspace.
Public Member Functions | |
Blueprint Functions | |
| bool | IsAvailable () |
| Returns true if the portal is available. More... | |
| void | OnPortalOpen () |
| An event that is called when the portal opens on the client, can be defined in blueprints. More... | |
| void | OnPortalClose () |
| An event that is called when the portal closes on the client, can be defined in blueprints. More... | |
| void | OnPortalOpenServer () |
| An event that is called when the portal opens on the server, can be defined in blueprints. More... | |
| void | OnPortalCloseServer () |
| An event that is called when the portal closes on the server, can be defined in blueprints. More... | |
| UMaterialInstance * | GetPortalMaterial () |
| Gets the material that needs to be displayed on the portal. More... | |
Public Attributes | |
Blueprint Members | |
| bool | AutoSetPortalMaterial = true |
| Automatically sets the portal material on a static mesh with the name "PortalDisplay". More... | |
| UMaterialInstance * | DefaultMapMaterial = nullptr |
| The default material for when the portal does not have a destination, or when the destination did not provide an image. More... | |
| float | TimeOutSeconds = 30 |
| After how many seconds the portal should automatically time out. More... | |
Member Function Documentation
◆ GetPortalMaterial()
| UMaterialInstance * AYomPortal::GetPortalMaterial | ( | ) |
Gets the material that needs to be displayed on the portal.
◆ IsAvailable()
| bool AYomPortal::IsAvailable | ( | ) |
Returns true if the portal is available.
◆ OnPortalClose()
| void AYomPortal::OnPortalClose | ( | ) |
An event that is called when the portal closes on the client, can be defined in blueprints.
◆ OnPortalCloseServer()
| void AYomPortal::OnPortalCloseServer | ( | ) |
An event that is called when the portal closes on the server, can be defined in blueprints.
◆ OnPortalOpen()
| void AYomPortal::OnPortalOpen | ( | ) |
An event that is called when the portal opens on the client, can be defined in blueprints.
◆ OnPortalOpenServer()
| void AYomPortal::OnPortalOpenServer | ( | ) |
An event that is called when the portal opens on the server, can be defined in blueprints.
Member Data Documentation
◆ AutoSetPortalMaterial
| bool AYomPortal::AutoSetPortalMaterial = true |
Automatically sets the portal material on a static mesh with the name "PortalDisplay".
◆ DefaultMapMaterial
| UMaterialInstance* AYomPortal::DefaultMapMaterial = nullptr |
The default material for when the portal does not have a destination, or when the destination did not provide an image.
◆ TimeOutSeconds
| float AYomPortal::TimeOutSeconds = 30 |
After how many seconds the portal should automatically time out.
