Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 2.19 KB

README.md

File metadata and controls

24 lines (21 loc) · 2.19 KB
Raw

Godot Attributes

This addon is a WIP. It is complete with the exception of multiplayer. Unit tests are being written whenever I have free time, which currently isn't much. As far as manual testing no issues have been noticed, but not everything has been tested; especially in terms of saving & loading attributes.

Documentation will eventually be written, but most of the code is annotated quite heavily (much of it is outdated and that is another TODO). If you want to use it just start with creating an Attribute node, use its public facing API (no _methods), and AttributeEffect resources.

Main Features

  • Attribute Node that contains two floating point values, a base value and a current value.
  • AttributeContainer Node to manage & contain each attribute instance in the parent node.
  • A simple "tagging" system, similar to that in Unreal's GAS. Add & remove tags to/from attribute containers.
  • Highly customizable AttributeEffects which can be applied to an Attribute to modify its values, block other effects, or modify other effects.
    • Permanent effects for base value changes
    • Temporary effects for buffs/debuffs to the current value
    • Instant, duration based, & infinite effects.
    • Highly configurable conditions for if an effect can be added or applied.
    • ModifiableValues provide
  • Accurate timing system for the applying of effects with a period & expiration of duration based effects.
    • Using Godot's Time class instead of process's delta allows for near 1ms accuracy.
  • Responsive & informative event/signal system
    • The emission of a single signal when safe to do so allows for the ability to instantly add & remove effects to an attribute while handling events from that attribute, without breaking the core logic.
    • AttributeEvent payload to that signal contains all of the information relevant to what change took place in an Attribute since the last event was emitted
  • Efficiency focused
    • Attribute nodes with no active effects have processing disabled & thus are extremely lightweight.
    • The core loop for an Attribute with active effects has been optimized to the best of my ability & within GDScript's own limitations. The most expensive operations are adding & removing