index.html

<!doctype html>
<html lang="en" data-color-mode="dark" data-dark-theme="dark_dimmed">

    <head>
        <meta charset="utf-8">
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <link rel="stylesheet" href="/_static/css/primer.css">
        <link rel="stylesheet" href="/_static/css/prism.css">
        <style>
            .markdown-content {
                box-sizing: border-box;
                margin: 0 auto;
            }

            .notes {
                background: #ffedd5;
                color: #292524;
                padding: 16px 32px;
                border: 4px solid #fdba74;
            }

            .notes ul {}

            .markdown-body code br {
                display: block;
            }

            @media (max-width: 767px) {
                .markdown-body {
                    padding: 15px;
                }
            }
        </style>
        <title></title>
    </head>

    <body>
        
<div class="Layout Layout--gutter-none">
    <div class="Layout-main">
        <header class="Header color-bg-default px-3 px-md-6 pt-3 pb-3 position-sticky top-0 z-3 border-bottom">
    <div class="Header-item Header-item--full">
        
    
    <nav aria-label="Breadcrumb">
        <ol>
                <li class="breadcrumb-item breadcrumb-item-selected">
                    <a href="/">Home</a>
                </li>
        </ol>
    </nav>

    </div>
    <div class="Header-item mx-3">
        <a href="/changelog" class="Header-link">Changelog</a>
    </div>
    <div class="Header-item mx-3">
        <a href="/Tests" class="Header-link">Test Reports</a>
    </div>
    <div class="Header-item mx-3">
        <a href="https://github.com/GASCompanion" class="Header-link">GitHub</a>
    </div>
    <div class="Header-item mx-3">
        <a href="https://discord.gg/d4rs4vcX6t" class="Header-link">Discord</a>
    </div>

    
</header>

        <div class="container-xl px-md-6">
            <div class="Layout-main">
                <main class="py-6 pr-6">
                    

<div class="mt-6 pt-3">
    <header class="d-lg-flex gutter-lg mb-6">
        <div class="col-12 mb-3 mb-lg-0">
            <h1>GAS Companion Documentation</h1>
            <div class="f2 color-fg-muted mb-3">
                <p>
                    Welcome to the documentation website for <a href="https://www.unrealengine.com/marketplace/en-US/product/gas-companion" target="_blank">GAS Companion</a> plugin.
                </p>
                
            </div>

            <a class="btn btn-large f4 mt-3 mr-3 btn-primary" href="/quick-start">Quickstart</a>
        </div>
    </header>
</div>

<div class="mt-6">
    <div class="d-lg-flex gutter my-6 py-6">
        <div class="col-12 mb-4 mb-lg-0 col-lg-6">
            <div class="mb-4 d-flex flex-items-baseline">
                <h2 class="f4 text-semibold">Guides</h2>
            </div>
            <ul data-testid="article-list">
                
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/quick-start">
                        <h3 class="f4">Getting Started</h3>
                        <p class="color-fg-muted mb-0 mt-1">Learn how to get started with GAS Companion</p>
                    </a>
                </li>
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/configuration">
                        <h3 class="f4">Configuration</h3>
                        <p class="color-fg-muted mb-0 mt-1">General Configuration for GAS Companion and Gameplay Abilities / Effects definition</p>
                    </a>
                </li>
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/attributes">
                        <h3 class="f4">Attributes</h3>
                        <p class="color-fg-muted mb-0 mt-1">How to create and work with your own AttributeSet and Gameplay Attributes and how to react to Attributes changes from Blueprints</p>
                    </a>
                </li>
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/melee-ability">
                        <h3 class="f4">Abilities</h3>
                        <p class="color-fg-muted mb-0 mt-1">Learn how to use the Melee Base ability with combo capabilities GAS Companion provides</p>
                    </a>
                </li>
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/topics">
                        <h3 class="f4">Topics</h3>
                        <p class="color-fg-muted mb-0 mt-1">Overview of specific topics such as the Ability Queue System, loose cost for abilities, debugging console commands, built-in Behavior Tree Tasks to use abilities and working with UI and UMG Widgets.</p>
                    </a>
                </li>
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/upgrade-guides">
                        <h3 class="f4">Upgrade Guides</h3>
                        <p class="color-fg-muted mb-0 mt-1">Upgrade Guide for ue5 release (what changed between v2/v3 and v5)</p>
                    </a>
                </li>
                
                <li tabindex="-1" class="py-1 px-2 d-flex border-top">
                    <a class="no-underline d-block py-1 py-3" href="/changelog">
                        <h3 class="f4">Changelog</h3>
                        <p class="color-fg-muted mb-0 mt-1">Detailed changelog for the plugin</p>
                    </a>
                </li>
                
            </ul>
        </div>

        <div class="col-12 mb-4 mb-lg-0 col-lg-6">
            <div class="mb-4 d-flex flex-items-baseline">
                <h2 class="f4 text-semibold">API</h2>
            </div>

            <ul>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/Components">
                        <span class="f4 text-bold d-block">Components</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/ModularGameplayActors">
                        <span class="f4 text-bold d-block">ModularGameplayActors</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/GameFeatures/Actions">
                        <span class="f4 text-bold d-block">GameFeatures/Actions</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/Abilities">
                        <span class="f4 text-bold d-block">Abilities</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/Abilities/Tasks">
                        <span class="f4 text-bold d-block">Abilities/Tasks</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/Abilities/Attributes">
                        <span class="f4 text-bold d-block">Abilities/Attributes</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/Animations">
                        <span class="f4 text-bold d-block">Animations</span>
                    </a>
                </li>
                
                <li tabindex="-1" class="d-flex border-top">
                    

                    <a class="no-underline d-block py-1 py-3" href="/api/UI">
                        <span class="f4 text-bold d-block">UI</span>
                    </a>
                </li>
                
            </ul>
        </div>
    </div>
</div>
                </main>
            </div>
        </div>

        <footer>
  <section class="container-xl px-3 mt-6 pb-8 px-md-6 color-fg-muted">
    <p>
      Built with <a href="https://www.11ty.dev" class="text-underline">Eleventy</a> and <a href="https://primer.style/" class="text-underline">Primer</a>.
    </p>
  </section>
</footer>
    </div>

    <div class="Layout-sidebar color-bg-subtle">
        
        
        <aside class="color-bg-subtle pt-6 px-3 position-sticky overflow-y-auto top-0" style="height: 100vh;"><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Overview</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/install/">
                        Installation
                    </a>
                </span>
                    </nav><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Getting Started</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/quick-start/">
                        Quick Start
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/asc-on-player-state/">
                        Setting up ASC on Player State
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/getting-started/modular-game-features/">
                        Modular Game Features
                    </a>
                </span>
                    </nav><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Configuration</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/config/ability-system-globals/">
                        Ability System Globals Configuration
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/config/ga-definitions/">
                        Gameplay Ability Definitions
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/config/ge-definitions/">
                        Gameplay Effect Definitions
                    </a>
                </span>
                    </nav><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Attributes</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/attributes/attributes-wizard/">
                        Attributes Wizard
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/attributes/attributes-events/">
                        Attributes Events
                    </a>
                </span>
                    </nav><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Abilities</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/melee-ability/">
                        Melee Base Ability
                    </a>
                </span>
                    </nav><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Topics</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/ability-queue-system/">
                        Ability Queue System
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/ignore-ability-cost/">
                        Loosely Check Ability Cost
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/console-commands/">
                        Console Commands
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/ability-sets/">
                        Ability Sets
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/working-with-ai/">
                        Working with AI
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/working-with-ui/">
                        Working with UI
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/animations/">
                        Anim Instance
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/reset-attributes-abilities/">
                        Reset Attributes / Abilities configuration
                    </a>
                </span>
                    </nav><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/more/">
                        More
                    </a>
                </span><h5 class="color-fg-muted mb-2 pb-1 border-bottom">Upgrade Guides</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/upgrade-guide/cpp/">
                        v5 Upgrade Guide (CPP usage)
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/upgrade-guide/">
                        v5 Upgrade Guide
                    </a>
                </span>
                    </nav><h5 class="color-fg-muted mb-2 pb-1 border-bottom">API</h5>
                <nav class="SideNav"><h5 class="color-fg-muted mb-2 pb-1 border-bottom">AI</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/AI/GSCBTTask_BlueprintBase/">
                        GSCBTTask_BlueprintBase
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Abilities/Attributes</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Abilities/Attributes/GSCAttributeSet/">
                        GSCAttributeSet
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Abilities/Tasks</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Abilities/Tasks/GSCAbilityTask_NetworkSyncPoint/">
                        GSCAbilityTask_NetworkSyncPoint
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Abilities/Tasks/GSCTask_PlayMontageWaitForEvent/">
                        GSCTask_PlayMontageWaitForEvent
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Abilities</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Abilities/GSCAbilitySystemComponent/">
                        GSCAbilitySystemComponent
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Abilities/GSCBlueprintFunctionLibrary/">
                        GSCBlueprintFunctionLibrary
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Abilities/GSCGameplayAbility/">
                        GSCGameplayAbility
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Abilities/GSCGameplayAbility_MeleeBase/">
                        GSCGameplayAbility_MeleeBase
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Abilities/GSCTargetType/">
                        GSCTargetType
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Animations</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Animations/GSCAbilityQueueNotifyState/">
                        GSCAbilityQueueNotifyState
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Animations/GSCComboWindowNotifyState/">
                        GSCComboWindowNotifyState
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Animations/GSCNativeAnimInstance/">
                        GSCNativeAnimInstance
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Components</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Components/GSCAbilityInputBindingComponent/">
                        GSCAbilityInputBindingComponent
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Components/GSCAbilityQueueComponent/">
                        GSCAbilityQueueComponent
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Components/GSCComboManagerComponent/">
                        GSCComboManagerComponent
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Components/GSCCoreComponent/">
                        GSCCoreComponent
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/Components/GSCLinkAnimLayersComponent/">
                        GSCLinkAnimLayersComponent
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Components/GSCPlayerControlsComponent/">
                        GSCPlayerControlsComponent
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Core/Editor</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Core/Editor/GSCExampleMapManager/">
                        GSCExampleMapManager
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Core/Settings</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Core/Settings/GSCDeveloperSettings/">
                        GSCDeveloperSettings
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">GameFeatures/Actions</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/GameFeatures/Actions/GSCGameFeatureAction_AddAbilities/">
                        GSCGameFeatureAction_AddAbilities
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/GameFeatures/Actions/GSCGameFeatureAction_AddAnimLayers/">
                        GSCGameFeatureAction_AddAnimLayers
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/GameFeatures/Actions/GSCGameFeatureAction_AddInputMappingContext/">
                        GSCGameFeatureAction_AddInputMappingContext
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">ModularGameplayActors</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/ModularGameplayActors/GSCModularActor/">
                        GSCModularActor
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/ModularGameplayActors/GSCModularCharacter/">
                        GSCModularCharacter
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/ModularGameplayActors/GSCModularDefaultPawn/">
                        GSCModularDefaultPawn
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/ModularGameplayActors/GSCModularPawn/">
                        GSCModularPawn
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/ModularGameplayActors/GSCModularPlayerState/">
                        GSCModularPlayerState
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Subsystems</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Subsystems/GSCConsoleManagerSubsystem/">
                        GSCConsoleManagerSubsystem
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">Templates</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/Templates/GSCTemplate_GameplayEffectDefinition/">
                        GSCTemplate_GameplayEffectDefinition
                    </a>
                </span>
                    </nav>
                    <h5 class="color-fg-muted mb-2 pb-1 border-bottom">UI</h5>
                <nav class="SideNav"><span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/UI/GSCUWDebugAbilityQueue/">
                        GSCUWDebugAbilityQueue
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/UI/GSCUWDebugComboWidget/">
                        GSCUWDebugComboWidget
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text"  href="/api/UI/GSCUWHud/">
                        GSCUWHud
                    </a>
                </span>
                    <span class="Truncate d-block">
                    <a class="SideNav-subItem Truncate-text mb-6"  href="/api/UI/GSCUserWidget/">
                        GSCUserWidget
                    </a>
                </span>
                    </nav>
                    </nav>
        </aside>
    </div>

</div>
    </body>

</html>