UnrealOni/Documentation

Assets

Import

Unprocessed files like PNG can be imported by drag and drop in the Content Browser.

They will be saved as .uasset in the folder you dropped the original file.

Mouse cursor

User widget with mouse cursor texture

Assigning a new mouse cursor

Tested in version 4.18, 4.22

• create a png with transparent edges, import it
• create a user widget, open it
• drag and drop the mouse cursor asset into the widget designer
• make it 32x32 in size 0, 0 in position
• compile and save
• open project settings
  • Engine > User Interface > Software Cursors
  • Add a new software cursor with "Default" option and pick your newly create cursor widget as map element.

The cursor might act strange in the editor's play mode. This should go away as soon as you test it via Lunch.

Finetune the widget image by moving it in the upper left corner. If its size is 32x32 then use the half (16) for the X and Y positioning.

Note of warning: DPI scaling doesn't seem to affect the mouse cursor at all.

User Input

Key binding

Key binding

You can bind actions to key (or other inputs) by going into Project Settings > Engine > Input.

Multiple keys for one action are also possible.

Note how movements use a scale for allow for eventually different direction values.

Processing

Double check: Input like key presses shouldn't be consumed by a character because characters can be replaced while playing.

The logic should be stored inside a controller otherwise you have to duplicate a lot of code inside all the characters, not to mention to keep that code up to date.

Movement controls might live inside the character BP.

Player-specific controls like opening the help menu should be inside a controller.

• Create a new AI controller, name it something like OniPlayerController
• Select the character in the world outliner or viewport, Ctrl + E to open the BP
• Search for "Controller" and set the "AI Controller Class" to the new OniPlayerController
• Add logic to the player controller (see Pause game)

Ignore inputs and pause game

pause game

Since F1 is used to switch into wireframe mode in UEditor, we will bind # to pause the game as we need the regular keys (any letter of the alphabet for the cheat code input).

Normally key inputs are ignored when the game is paused.

In order to unpause the game we need to set the key to "Execute when Paused [x]" in the details panel.

Theoretically a flipflop could be used to register the second key input but the game could have been paused by other means so it is better to use an variable here. Luckily Unreal provides just that as a boolean node.

To let the game behave like a typical game pause inputs for character move and look are ignored. This is actually redundant as the game is paused.

We can recycle those ignore nodes later for game menus that don't require the game to pause.

Cheat codes

Find longest cheat

Detect cheats

Unreal has a Cheat code class but that doesn't ship with cooked games.

https://www.youtube.com/watch?v=hM_MPrEN7t8

Also, to detect combinations of keys pressed ("shapeshifter", "lifeforever", etc.) we would have to write our own code anyway.

Instead of detecting each key press individually we can use the Any key event and then get key names, mostly capitalized letters for standard alphabet characters.

The letters will be stored in a string which we will keep at a maximum length of the longest cheat. The string is then compared against an array of cheat codes.

The string is cleared as soon as a cheat is found. A case select a.k.a. switch node can handle the different cheat functions.

Carousel

Slow motion cheat "carousel"

Character scaling

Behemoth function with scaling parameter (recycled for other character scalings)

This is basically one function with one free parameter for the scaling.

The central node in this is the "Set Actor Scale 3D".

• minime (0.5)
• behemoth (2)
• godzilla (4)

For accurate toggling we would need some additional code though but for now it works.