Game Overview

PortalGadgetExample is a sample that allows the player to have a Portal Gadget and receives input such as aiming, shooting, and laser switching using a script.

The main point is that you can receive the player's intentions using special gadgets, rather than using substitute operations such as "crouch and execute".

Main Topics

• Add the Portal Gadget with mod.AddEquipment(player, mod.Gadgets.Misc_PortalGadget).
• Receive fire input at OnPortalGadgetFireStart, OnPortalGadgetFireStop.
• Receive aiming input at OnPortalGadgetAimStart, OnPortalGadgetAimStop.
• Enable/disable the mode with OnPortalGadgetLaserToggle.
• Use player gaze direction with RayCast, OnRayCastHit, OnRayCastMissed.
• Switch between teleport mode and object creation mode with InteractPoint.

Reading Order

1. Check equipment grants

Portal Gadget is assigned at OnPlayerDeployed.

The process of handing over equipment when the player deploys is easy to use in other modes as well.

2. Check input events

Portal Gadget input is received in a separate event from the normal OnPlayerInteract.

3. Check RayCast

In this sample, a RayCast is launched from the player's line of sight, teleporting to the point it hits, and creating an object.

The flow you should see is GetRayCastVectors → mod.RayCast → OnRayCastHit / OnRayCastMissed.

Small Tips

It has the current mode as a number, like currentSwitchMode. If you create it yourself, it will be easier to read if you use a string type like "Teleport" or "SpawnObject".

It is also helpful to see the reason given at DisplayHighlightedWorldLogMessage when RayCast fails. If it doesn't respond to input, it feels "broken" to the player.

Conclusion

Portal Gadget is a powerful tool for creating active player input.

In this sample, please focus on the flow of gadget attachment, input events, RayCast, mode switching, and failure messages.