How to Add Player Input

The following guide shows how to set up player input using Verse in your Unreal Editor for Fortnite project. For more details on what player input is and the event lifecycle, check out Player Input.

Adding Player Input

Follow these steps to add player input to your project.

1. Import the input modules. 

   Verse

   using { /Verse.org/Input }
   using { /Fortnite.com/Input/Character }

   Copy full snippet(2 lines long)

2. Call GetPlayerInput, which is a failable function, and add a mapping to activate its input actions. This example uses TraversalMapping.

   Verse

   if (PlayerInput := GetPlayerInput[Player]):
       PlayerInput.AddInputMapping(TraversalMapping)

   Copy full snippet(2 lines long)

3. Use GetInputEvents with a specific input action to get its event container, then subscribe to the event you want. This example subscribes the OnJump handler function to the TriggerActivationEvent event from the Jump input action.

   Verse

   if (PlayerInput := GetPlayerInput[Player]):
       PlayerInput.AddInputMapping(TraversalMapping)
       PlayerInput.GetInputEvents(Jump).TriggerActivationEvent.Subscribe(OnJump)

   Copy full snippet(3 lines long)

4. Define the handler function whose signature matches the event payload. In this example, the payload is of type tuple(player, logic).

   Verse

   OnJump(Payload : tuple(player, logic)) : void =
       Print("Player jumped!")

   Copy full snippet(2 lines long)

5. Subscribe returns a cancelable. Store it in a variable and call Cancel() when you no longer need to receive events.

   Verse

   var JumpSubscription : ?cancelable = false
       # Later, when subscribing:
   
       if (PlayerInput := GetPlayerInput[Player]):
           Sub := PlayerInput.GetInputEvents(Jump).TriggerActivationEvent.Subscribe(OnJump)
           set JumpSubscription = option{Sub}
   
       # When done listening:
       if (Sub := JumpSubscription?):
           Sub.Cancel()

   Copy full snippet(10 lines long)

6. Use RemoveInputMapping to deactivate a set of input actions. Once removed, input actions within that mapping stop producing events.

   Verse

   if (PlayerInput := GetPlayerInput[Player]):
       PlayerInput.RemoveInputMapping(RangedWeaponMapping)
   

   Copy full snippet(2 lines long)

Complete Example

The following example demonstrates a device that subscribes all players to Jump and WeaponPrimary events, then cleans up after a set duration.

using { /Fortnite.com/Devices }
using { /Fortnite.com/Input/Character }
using { /Verse.org/Input }
using { /Verse.org/Simulation }
using { /UnrealEngine.com/Temporary/Diagnostics }

input_example_device := class(creative_device):

    var JumpSub : ?cancelable = false
    var FireSub : ?cancelable = false

Tips for Coding Player Input

Keep the following tips in mind when working with player input in Verse:

• Always add the input mapping before subscribing to its actions. Subscriptions to actions without an active mapping will not fire.

• Store cancelable references and cancel them during cleanup. Subscriptions persist until explicitly canceled, which can lead to unintended behavior if left active.

• Use BeginDetectEvent when you want an immediate response to a key press.

• Use TriggerActivationEvent when the action should only fire after all activation conditions are met.