Skip to content

Latest commit

 

History

History
118 lines (85 loc) · 4.03 KB

README.md

File metadata and controls

118 lines (85 loc) · 4.03 KB
Raw

GDAbilitySystem

An Ability System extension for Godot 4

This extension provides a framework for implementing game mechanics. It's inspired by Unreal Engine's Gameplay Ability System.

Table of Contents

  1. Installation
    1. If you want to include the source files
    2. If you just want the build
    3. For Godot Mono (C#)
  2. Class overview
    1. AbilitySystem
    2. Ability
    3. AbilityEvent
    4. Attribute
    5. Effect
    6. Tag
    7. Viewer classes
  3. Tutorial (coming soon)

Installation

If you want to include the source files

  1. Clone this repository somewhere into your project files
  2. Update ability_system.gdextension with the path to the bin folder in your project, if necessary
  3. Open or restart Godot

If you just want the build

  1. Copy the bin folder, the assets folder (for the icons), and the ability_system.gdextension file somewhere into your project
  2. Update ability_system.gdextension with the path to the bin folder and the assets folder in your project, if necessary
  3. Open or restart Godot

For Godot Mono (C#)

Follow the regular installation steps first.

  1. Restart your editor
  2. Make sure AbilitySystem.cs is copied somewhere into your project
  3. In Godot's menu bar, click: Project → Tools → Ability System → Generate C# Bindings
  4. Build your project

Class overview

AbilitySystem

This node can be added as a child to give its parent access to abilities, tags, attributes, etc.

Ability

An ability defines an action or skill that can be granted to any node that has a child AbilitySystem.

Examples

  • Restore health
  • Do an attack
  • Find an object

AbilityEvent

An ability event defines the state of an Ability after activation. This class controls the ability's Effects.

Attribute

Attributes are a numerical value representing some in-game property.

Examples

  • Health
  • Hunger
  • Intelligence

Effect

An effect defines what happens in-game when an Ability is activated.

This is where the bulk of your custom game logic will go. It has access to the AbilitySystem so an effect can read tags, modify the scene tree, or really anything else.

Examples

  • For an attack spell ability, the effects could be...
    • Decrease the mana attribute
    • Play a cool spell animation
    • Decrease health of any enemies in the surrounding area
  • For an object finding ability, the effects could be...
    • Locate the object within the world
    • Move character to the object
    • Play pick up animation

Subclasses

  • AttributeEffect - modifies an Attribute
  • TagEffect - adds or removes Tags from AbilitySystem
  • WaitEffect - arbitrarily delays AbilityEvent
  • TryActivateAbilityEffect - attempts to activate an Ability on the AbilitySystem
  • LoopEffect - runs all the previous effects again

Tag

Tags are names that classify and describe the state of an AbilitySystem node. They can be used together with abilities to create super dynamic states.

Examples

  • spells/is_casting
  • spells/has_cast_recently
  • is_sleepy

Viewer classes

These classes are mainly used for debugging purposes. They are Control nodes that can be added to your scene. Each of them export an AbilitySystem property and will be reactive to changes on that AbilitySystem. They work both in-editor and in-game.

AbilitySystemViewer

A container for the other viewer nodes. Displays Tags, Attributes, AbilityEvents, and Abilitys when provided an AbilitySystem.

TagViewer

Displays Tags when provided an AbilitySystem.

AttributeViewer

Displays Attributes and their values when provided an AbilitySystem.

EventViewer

Displays AbilityEvents when provided an AbilitySystem.

AbilityViewer

Displays Abilitys when provided an AbilitySystem.