# Quick Start Guide

UE 5.7+ Version 1.0

Get up and running with AP StatusFX Suite in under 5 minutes.

Support: discord.gg/n5HxmrkpC4

---

# 1. Installation

1. Copy the AfterPrimeStatusFXSuite/ folder into your project's Plugins/ directory.
2. Open your .uproject — Unreal will detect the new plugin and compile it automatically. If prompted about missing modules, click Yes to build.
3. Open the editor — confirm the plugin is enabled under Edit → Plugins → AfterPrime.

---

# 2. Add the Component

The StatusFX Suite is a single component you add to any replicated actor.

1. Open your Character or Pawn Blueprint.
2. Click Add Component → search for "AP StatusFX Suite" → add it.
3. The component handles all replication automatically — no additional setup required.

---

# 3. Implement the Interface (Optional but Recommended)

The IAP_StatusFXSuiteTarget interface lets other systems find the component on your actor without hard references.

1. Open your actor Blueprint → Class Settings.
2. Under Interfaces → Add → search for "StatusFX Suite Target".
3. Compile the Blueprint.
4. In My Blueprint → Interfaces, double-click GetStatusEffectComponent.
5. Drag your AP_StatusFXSuite component from the Components panel → connect it to the Return Value pin.
6. Compile.

---

# 4. Create an Effect Definition

Status effects are defined as Data Assets — no code required.

1. In the Content Browser: Right-click → Miscellaneous → Data Asset.
2. Select AP_StatusEffectDefinition as the class.
3. Name it with the SFX_Def_ prefix (e.g., SFX_Def_Poison).

# Configuration Properties

# Example: A Simple Poison DoT

---

# 5. Apply an Effect

In any Blueprint graph, search for "Apply Effect to Actor" (under AP > StatusFX > Helpers):

Pin	Description
Target Actor	The actor to apply the effect to (defaults to Self).
Definition	Your StatusEffectDefinition asset (e.g., SFX_Def_Poison).
Instigator	The actor that caused the effect (optional, for tracking).
Duration Override	Set to -1.0 to use the definition's default duration.

If you have a direct reference to the component:

1. Get the AP_StatusFXSuite component reference.
2. Call Apply Effect.
3. Pass the Definition, Instigator, Duration Override, and Initial Stacks.

---

# 6. Listen for Events

The component provides 6 delegates you can bind in Blueprint:

# Binding in Blueprint

1. Get your AP_StatusFXSuite component reference.
2. Drag off it → type "Assign On Effect Applied".
3. This creates a bound event node — add your logic (Print String, UI update, gameplay response, etc.).

# The Snapshot

Most delegates provide an FAP_StatusEffectSnapshot with:

---

# 7. Query Active Effects

All query methods work on both server and client (they read replicated state).

---

# 8. Stacking Policies

Each definition specifies how reapplication behaves:

---

# 9. Interaction Rules

Effects can interact with each other in two ways:

# Per-Definition (on the Data Asset)

# DataTable Rules (Project Settings)

For complex interactions with immunity grants:

1. Create a DataTable using FAP_EffectInteractionRule as the row struct.
2. Each row defines: SourceTag, TargetTagsToRemove, bGrantImmunityToRemoved, ImmunityDuration.
3. Assign the DataTable in Project Settings → Plugins → AP StatusFX Suite → Interaction Rules DataTable.

---

# 10. Immunity System

---

# 11. Project Settings

Project Settings → Plugins → AP StatusFX Suite

---

# 12. Multiplayer Notes

---

# 13. Demo Content

The plugin ships with a complete demo in Content/Demo/:

To test: Open MAP_StatusFX_Demo, set players to 2 (Listen Server), and press Play. Use keys 1–6 to apply effects, 0 to remove all.

---

# Next Steps

• API Reference — complete list of methods, delegates, and types
• FAQ — common questions answered
• Changelog — version history and planned features

---

AfterPrime Systems — Building the Gameplay Foundation