BT_Task documentation

BT_Tasks

@@ -0,0 +1,91 @@
+# Simple Line
+Display a line in the subtitles and play an audio-file. Apply modifiers based on and display an orgin character.
+
+Parameters:
+- audio ressource
+- text line
+- orgin
+
+# Dialog Choice
+Initialize a dialog, with given choices. Must be followed by an selector and DialogChoice-Decorators.
+
+Parmeters:
+- Array of choices, choice selection is based on ID, so display text may be choosen freely
+- Timeout, the time you have to choose an option
+
+# EnableAWaypointByTag
+Enables the first waypoint found with the given Tag.
+
+Parameters:
+- Tag (Name) to enable
+
+# RunSubDialog
+Run a given behaviour Tree and then return to the current one.
+
+Parameters:
+- BehaviourTree to execute
+
+# SetActorHiddenState
+Changes the hidden state of the first actor found with a given tag.
+
+Parameters:
+- tag (Name)
+- Hidden State (True = Hidden, False = Visible)
+
+# Stop Execution
+Stops the execute of this BT.
+
+# EnableAiMovementByTag
+Enable an AI-Movement point similary to enabling a waypoint.
+
+Parameters:
+- Tag (Name) to enable
+
+# Remove Actor from Level
+Sets an actor to be hidden and moves it out of the playable area.
+
+Parameters:
+- Array of Actor Softreferences
+- Boolean Delete Children
+
+# Save Game
+Save the current in-level game for it to be reloaded see the [Save Game Documentation](https://github.com/FAUSheppy/sector-32-documentation/blob/main/Savegames.md) for details.
+
+Parameters:
+- Display String (String which is used as a name for the savepoint)
+- DryRun Boolean (if true, only simulate the save and do not actually make changes)
+
+# Shoot at player from Anywhere
+Shoot at the player from the location of an actor.
+
+Parameters:
+- ActorSoftReference source actor
+- Timeout (float, pause between shots)
+
+# Remove Companion
+Same thing as Remove actor, just specific to companions.
+
+Paramters:
+- Tag of the companion to hide and move
+
+# Spawn In Companion
+Spawn in a companion close to the player. The Companion must already exists in the Level and will only be moved and made visible based on it's tag.
+
+Parameters:
+- Tag of the companion (e.g. Riz/Mark)
+
+# Set Input Lock State
+Toggle the input lock for the player.
+
+Parameters:
+- Input LEnabled (True/False)
+
+# Fly In Front of Player
+Currently does nothing, only waits for 5s.
+
+# Fade out to next Level
+Lock input, fade out current view and load the specified Level.
+
+Parameters:
+- NextLevel (Name of next Level to be loaded)
+