💡Getting Start
After download the plugin, check if the plugin is enabled.
🧍Configuring Character
After making sure the plugin is activated, you need add Interactor Component to your character.
You can edit Interactor settings in Details tab
Interaction Active
Change this variable on the server to modify whether this player can use UIS
Trace Type
Explore tags in "UIS.Mode" section. You can create new game tags in this section and use here, just override "CustomTrace" function to use ;)
Default Tags are:
1. UIS.Mode.Proximity /* You need to follow the process at the end of this page */ 2. UIS.Mode.ScreenCenter
Trace Distance
If you are using TraceType = ScreenCenter, this is the distance of the trace from the center of the screen forward.
If you are using TraceType = Proximity, this is the radius of the detection sphere
If you are using TraceType = Custom, you can use this variable as you wish.
Trace Detection Channel
Defines the collision profile of the trace, both sphere and line (You can use this on your Custom Trace Mode)
Debug
Enable this setting if you want to see Traces and detailed information about the UIS system.
Trace Time
Define delay between detection traces
🧊Configuring Interactables
Create a actor and add Interactable Component to him.
You can edit Interactable settings in Details tab
Can Interact
Determine if you can interact with the Interactable
Disable on Interact
Check this if you want the interaction to be disabled after a valid interaction.
Need Hold
Check this if you want the player to have to hold the interact button for a certain time until the interaction is performed.
Hold Target Value
Determine how long the player needs to hold the interaction button for the interaction to complete.
Only used if NeedHold is true
Name
The name of the Interactable that will appear in the Widget
Tooltip
A brief description of the Interactable that will appear in the Widget
The Interactable component is a child of the Widget Component and comes with the default interaction widget, but you can change that in Widget Class property.
To determine the Interaction Events, simply scroll down the Details tab until you find Events
On Interact It is called when the player successfully completes an interaction.
On Start Detection
It is called when player start detect actor
On End Detection
It is called when player stop detect actor
On Interact is called on the Server by default, so you can add other RPC Events, such as a Multicast event.
The Getting Start end here. Below process is only necessary if you are using the "Screen Center" detection mode.
Add UIS Interface to your character.
Override GetStartLocationAndEndLocation function
Start location need be equal camera location | End location need be equal to camera forward vector
Last updated