Skip to content
This repository was archived by the owner on Jun 7, 2025. It is now read-only.

Commit 723feb7

Browse files
committed
Update README.md
1 parent e5ee538 commit 723feb7

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ The plugin can be used in both C++ and Blueprint projects.
1010

1111
**At the moment, the package is compatible only with Unreal Engine 4.**
1212

13-
1. Download [**package file**](https://github.com/TrickyFatCat/TrickyInteractionSystem/releases/tag/v1.1);
13+
1. Download the latest [**package file**](https://github.com/TrickyFatCat/TrickyInteractionSystem/releases/);
1414
2. Unzip the package to the Plugins folder in engine folder, e.g. `C:\Program Files\Epic Games\UE_4.27\Engine\Plugins`;
1515
3. Restart the project;
1616

@@ -30,6 +30,7 @@ The plugin contains:
3030
1. InteractionQueueComponent;
3131
2. InteractionInterface;
3232
3. InteractionLibrary;
33+
4. Interaction Triggers;
3334

3435
### InteractionQueueComponent
3536

@@ -69,6 +70,8 @@ This component handles creating a queue for interaction which it sorts by weight
6970
1. `OnInteractionStarted` - called when the interaction process started;
7071
2. `OnInteract` - called when the interaction effect successfully activated;
7172
3. `OnInteractionStopped` - called when the interaction process stopped;
73+
4. `OnActorAdded` - called when a new actor was added to the queue;
74+
5. `OnActorRemoved` - called when an actor was removed from the queue;
7275

7376
### Interaction data
7477

@@ -108,13 +111,33 @@ A library which contains some useful functions for custom implementation of the
108111
9. `GetFirstQueueData` - return the first data in the queue;
109112
10. `UpdateInteractionMessage` - updates the interaction message of the given interactive actor;
110113

114+
## Interaction Triggers
115+
116+
A small collection of trigger components which add and remove their owning actor from the interaction queue.
117+
118+
1. BoxInteractionComponent;
119+
2. CapsuleInteractionComponent;
120+
3. SphereInteractionComponent;
121+
122+
### Parameters
123+
124+
1. `InteractionData` - interaction data which will be added to the interaction queue;
125+
126+
### Functions
127+
128+
1. `SetInteractionMessage` - sets interaction message in the `InteractionData` and updates it in the interaction queue;
129+
130+
### Delegates
131+
132+
1. `OnActorAdded` - called when the owning actor was added to the queue;
133+
2. `OnActorRemoved` - called when the owning actor was removed from the queue;
134+
111135
## Quick Setup
112136

113137
1. Add InteractionQueueComponent to your character;
114138
2. Create an interactive actor:
115139
* Add InteractionInterface to the chosen actor and write the logic in the `Interact` function;
116-
* Add a trigger;
117-
* Add the actor to the interaction queue if the actor enters the trigger;
118-
* Remove the actor from the interaction queue if the actor exits the trigger;
140+
* Add an interaction trigger;
141+
* Adjust interaction data in the trigger;
119142
3. Create "Interaction" input action;
120143
4. Call the `StartInteraction` function of InteractionQueueComponent;

0 commit comments

Comments
 (0)