UE Plugin (4.27)

Installation and Setup

How to load the PaperMap

Set up your COALA API Key

Builds for Mobile

Builds for Android

Builds for iOS

Move around the map by clicking/tapping

Smooth Movement

How to load the PaperMap

The UE Plugin itself comes with an example map where everything is prepared and configured for you: The PaperMap

To use this map you need to follow a few steps.

Create new project

2. Select "Blank" template

3. Sample project settings could look like this.

After the project is created, the editor will start.

4. Make sure that the following are enabled:

Plugin "Coala Blueprints"

Mobile Location Services - Android Implementation
Mobile Location Services - IOS Implementation
Mobile Location Services Blueprint Library

Procedural Mesh Component

5. You can already have a sneak peak into the "Coala_Paper_Map" level that is located here:

ThoughtfishCoalaPlugin Content -> PaperMap -> Content -> PaperMap

6. Load the level, press play, and wait until the map is generated.

Tip: If you want to observe how the level is generated, uncheck the "Show Loading" box on the "BP_Coala_Interface" actor.

7. As soon as the map is loaded, click "Eject" to detach from the player controller.

And investigate the scene as you please.

Set up your COALA API Key

To use the configurations of your own project in the COALA Backend, simply update the Coala Project Api Key field to the Project Key found in the Configuration page in the Backend. This field is located in the Setup section of the BP_Coala.

Builds for Mobile

Under Project Settings, set the "Coala_Paper_Map" level as the default map for Editor and Game.

Verify that your "Platforms - Android" settings are correct.

We used the following:

check "Pack game data inside .apk?"
check "Support arm64 [aka arm74-v8a]"
check "Support OpenGL ES3.1"

Extend Platform.ini file with the following values

(This will allow more objects to be spawned by the engine, which is needed for decorations)

[/Script/Engine.GarbageCollectionSettings]

gc.MaxObjectsInGame=1310720

gc.TimeBetweenPurgingPendingKillObjects=300.000000

To start the build, navigate to

File -> Package Project -> Android -> Android (Multi: ASTC,DXT,ETC2)

select a save path and wait for the result

The .apk (android package file) can now be used to install the example on an android device.

Builds for Android

Make sure you have added the extra permissions needed for GPS:

android.permission.ACCESS_GPS
android.permission.ACCESS_LOCATION
android.permission.ACCESS_FINE_LOCATION
android.permission.ACCESS_COARSE_LOCATION

Builds for iOS

Make sure you have enabled "Allow web connections to non-HTTPS websites" if building for iOS.

Move around the map by clicking/tapping

Configure the input bindings in the editor (as in the image below)

SetDestination
InteractPOI
ZoomIn

(Tip: Verify that "Action Mappings" is spelled correctly because it needs to match the values in the Plugin)

In the "World Outliner" select "BP_Coala".

Check "Enable Movement by Click" in the Details panel

Press play and as soon as the map is loaded...

...you can move around the generated world by right-clicking on it

Smooth Movement

If you want to enable a smooth character movement when using the above functionality to move by clicking/tapping, you can check the Smooth Movement checkbox and set a movement speed in the Speed field.

Please note that for the smooth movement to be enabled, you MUST check the Use Mouse for Touch check box located in Window -> Project Settings -> Engine -> Input -> Mouse Properties -> Advanced

Page updated

Report abuse