UE Plugin

BP_POI

Description

The main blueprint for the COALA POIs. Only contains logic, no content. You should create a child to use it.

Components

Parent

The main static mesh of the POI.

Collision

A collision box. Is used to check if a player has clicked on the POI.

Sphere

A collision sphere. Can be used to create interactions with the player.

ZoomPoint

The point the camera zooms to when the setting "ZoomToPOI" is activated.

ShowWidgetPoint

The starting position where the widget is shown when the setting "WidgetStyle: Dynamic" is activated.

Arrow

Shows the front axis.

Variables

Intern

Widget:

private: Reference to POI widget

CoalaPlayer:

private: Reference to player.

Settings

UseWidget:

Shows a widget.

CloseOldWidget:

Closes the last widget when a new one is clicked.

ZoomToPOI:

Zoom to the POI when the widget is shown.

ZoomRotate:

Rotation angle while zooming.

StopMovementByShow:

Stops the player movement when the widget is shown.

Widget Settings

WidgetStyle:

Static: The widget will simply be shown on the screen.

Dynamic: The widget will be shown at the ShowWidgetPoint. It behaves like a 3D Widget.

WidgetClass:

Class for the POI widget:

The widget must be lead by "WI_Poi_Coala".

WidgetSize:

The size in which the widget should be shown

POI Info

PoiName:

Name of the POI.

PoiDescription:

Description of the POI.

PoiIcon:

Icon of the POI.

Widget Dynamic

WidgetOffset:

Here the offset for a dynamic widget is set. A widget is always created from the top left. If you want it to be on the bottom right, you can set a negative offset of the size of the widget.

Functions

ConstructionScript (default)

The ConstructionScript handles the scaling of the POI.


CoalaScaling

Scales the POI.

ZoomToActor

Starts a zoom to the POI.

ZoomToPlayer

Zooms back to the player.

IsWidgetVisble

Shows if the widget is visible or not.

Events

Beginplay(default)

Prepares the widget, if one is used.

TogglePoiInfo

Shows or hides the widget.

ShowWidget

Shows the widget.

HideWidget

Hides the widget.