├── .gitattributes ├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── SECURITY.md ├── addons.jsonc ├── addons ├── .editorconfig └── enhanced_stat │ ├── icons │ ├── ecg_icon.png │ ├── icons8-square-24.png │ ├── icons8-stats-24 (1).png │ ├── icons8-stats-24.png │ ├── icons8-system-task-24.png │ └── pulse_icon.png │ ├── plugin.cfg │ ├── plugin.gd │ ├── scenes │ └── editor │ │ └── stats │ │ ├── bind │ │ ├── StatBindKeyButton.tscn │ │ └── StatBindPropertyButton.tscn │ │ ├── listeners │ │ └── StatListenerButton.tscn │ │ └── modifiers │ │ └── StatModifierButton.tscn │ └── scripts │ ├── core │ ├── stats │ │ ├── bind │ │ │ ├── abstract_stat_bind.gd │ │ │ └── stat_bind.gd │ │ ├── listeners │ │ │ └── stat_listener.gd │ │ ├── modifiers │ │ │ ├── aggregated │ │ │ │ ├── _aggregated_stat_modifier.gd │ │ │ │ └── pool │ │ │ │ │ ├── _pool_stat_modifier.gd │ │ │ │ │ ├── float_pool_stat_modifier.gd │ │ │ │ │ └── int_pool_stat_modifier.gd │ │ │ ├── computed │ │ │ │ ├── _computed_stat_modifier.gd │ │ │ │ ├── bool_stat_modifier.gd │ │ │ │ └── number │ │ │ │ │ ├── _number_stat_modifier.gd │ │ │ │ │ ├── float_stat_modifier.gd │ │ │ │ │ └── int_stat_modifier.gd │ │ │ └── stat_modifier.gd │ │ ├── stat │ │ │ ├── aggregated │ │ │ │ ├── _aggregated_stat.gd │ │ │ │ └── pool │ │ │ │ │ ├── _pool_stat.gd │ │ │ │ │ ├── float_pool_stat.gd │ │ │ │ │ ├── growable │ │ │ │ │ ├── _growable_pool_stat.gd │ │ │ │ │ ├── float_growable_pool_stat.gd │ │ │ │ │ └── int_growable_pool_stat.gd │ │ │ │ │ └── int_pool_stat.gd │ │ │ ├── computed │ │ │ │ ├── _computed_stat.gd │ │ │ │ ├── bool_stat.gd │ │ │ │ └── number │ │ │ │ │ ├── _number_stat.gd │ │ │ │ │ ├── float_stat.gd │ │ │ │ │ └── int_stat.gd │ │ │ └── stat.gd │ │ ├── stats.gd │ │ └── stats_manager.gd │ └── status_effects │ │ ├── components │ │ ├── _status_effect_component.gd │ │ ├── stat_modifier_status_effect_component.gd │ │ └── vfx_status_effect_component.gd │ │ ├── status_effect.gd │ │ ├── status_effect_abstract.gd │ │ ├── status_effect_applier.gd │ │ └── status_effect_manager.gd │ ├── editor │ └── stats │ │ ├── bind │ │ └── stat_bind_editor.gd │ │ ├── listeners │ │ ├── stat_listener_button.gd │ │ └── stat_listener_editor.gd │ │ └── modifiers │ │ ├── stat_modifier_button.gd │ │ └── stat_modifier_editor.gd │ └── utils │ └── stat_utils.gd ├── docs ├── .nojekyll ├── README.md ├── _sidebar.md ├── assets │ ├── logo.png │ ├── stat_binding_configuration.png │ ├── stat_binding_dropdown.png │ ├── stats_manager.png │ ├── status_effect_applier.png │ ├── stun.png │ └── stun_files.png ├── contribute.md ├── index.html └── manual │ ├── main.md │ ├── stats │ ├── aggregated.md │ ├── bind.md │ ├── computed.md │ ├── create.md │ ├── main.md │ └── modifiers.md │ └── status_effects │ ├── components.md │ └── main.md ├── examples ├── Main.tscn ├── MainCharacter.tscn ├── StunVfx.tscn ├── Trap.tscn ├── icons │ ├── icons8-heart-24.png │ ├── icons8-puppet-24.png │ ├── icons8-running-24.png │ └── icons8-speed-24.png ├── main_character.gd ├── stats │ ├── character_stats.gd │ ├── character_stats_manager.gd │ ├── controllable_stat.gd │ ├── health_stat.gd │ ├── main_character_stats.tres │ └── speed_stat.gd ├── stun.tres └── trap.gd └── project.godot /.gitattributes: -------------------------------------------------------------------------------- 1 | # Normalize EOL for all files that Git considers text files. 2 | * text=auto eol=lf 3 | 4 | # Ignore some files when exporting to a ZIP. 5 | # Only include the addons folder when downloading from the Asset Library. 6 | /addons/enhance_common !export-ignore 7 | /addons/enhance_common/** !export-ignore 8 | 9 | # Also include script templates. 10 | /script_templates !export-ignore 11 | /script_templates/** !export-ignore -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | !addons/.editorconfig 2 | # Godot 4+ specific ignores 3 | .godot/ 4 | # Godot-specific ignores 5 | .import/ 6 | **/*.import 7 | export.cfg 8 | export_presets.cfg 9 | 10 | # Mono-specific ignores 11 | .mono/ 12 | data_*/ 13 | .godot/ 14 | 15 | addons/enhanced_common/* 16 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | . 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | Thank you for contributing to enhance. Feel free to fork this repository and raise a pull request. 2 | 3 | ## Contributing to Enhanced Stat :handshake: 4 | 5 | We warmly welcome contributions to the Enhanced Stat project! To maintain code quality and consistency, we follow the GitFlow branching model. Below is a quick guide on how to contribute using GitFlow. 6 | 7 | --- 8 | 9 | ### GitFlow Overview :book: 10 | 11 | The GitFlow workflow employs two parallel long-running branches to record the history of the project, `main` and `develop`: 12 | 13 | - **Main**: This branch reflects the latest stable release of the project. 14 | - **Develop**: This is the main branch where the source code of `HEAD` reflects a state with the latest delivered development changes for the next release. 15 | 16 | Feature branches, release branches, or hotfix branches will typically branch off from `develop`. 17 | 18 | --- 19 | 20 | ### Getting Started :rocket: 21 | 22 | 1. **Fork the Repository**: Start by forking the Enhanced Stat GitHub repository to your own GitHub account. 23 | 24 | 2. **Clone the Repository**: Clone your fork locally on your machine. 25 | 26 | ```bash 27 | git clone https://github.com/[YourUsername]/enhanced_stat.git 28 | ``` 29 | 30 | 3. **Set Upstream**: Add the original repository as an upstream remote. 31 | 32 | ```bash 33 | git remote add upstream https://github.com/original-repo/enhanced_stat.git 34 | ``` 35 | 36 | 4. **Create a Feature Branch**: Any new feature or bugfix should be developed in a separate branch. 37 | 38 | ```bash 39 | git checkout -b feature/your-feature-name develop 40 | ``` 41 | 42 | 5. **Commit Your Changes**: Make your changes and commit them. 43 | 44 | ```bash 45 | git add . 46 | git commit -m "Implemented feature X" 47 | ``` 48 | 49 | 6. **Push and Create a Pull Request**: Push your changes to your fork and create a pull request from there to the original repository. 50 | 51 | ```bash 52 | git push origin feature/your-feature-name 53 | ``` 54 | 55 | ### Code Review :mag: 56 | 57 | After you've made a pull request, maintainers and contributors will review your code. You may need to make some adjustments before your code is merged into the `develop` branch. 58 | 59 | --- 60 | 61 | By adhering to the GitFlow branching model, we ensure a clean and understandable history, make the development process more efficient, and facilitate contributions from multiple developers. Thank you for considering contributing to Enhanced Stat! :heart: -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Zennyth 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ✨ Enhanced Stat for Godot 4.1 2 | 3 | [![Godot Version](https://img.shields.io/badge/Godot-4.1-brightgreen.svg)](https://godotengine.org) 4 | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) 5 | [![Static Badge](https://img.shields.io/badge/Doc-0.0.1-blue)](https://zennyth.github.io/EnhancedStat/) 6 | 7 | --- 8 | 9 | ## 🔍 Table of Contents 10 | 11 | - [✨ Enhanced Stat for Godot 4.1](#-enhanced-stat-for-godot-41) 12 | - [🔍 Table of Contents](#-table-of-contents) 13 | - [📖 Overview](#-overview) 14 | - [📦 Installation](#-installation) 15 | - [🚀 Features](#-features) 16 | - [📈 Stats](#-stats) 17 | - [⚡ Status Effects](#-status-effects) 18 | - [💻 Editor Friendly](#-editor-friendly) 19 | - [🔗 Dependencies](#-dependencies) 20 | - [📁 Project Architecture](#-project-architecture) 21 | - [📗 Usage](#-usage) 22 | - [📝 Documentation](#-documentation) 23 | - [🍻 Contributing](#-contributing) 24 | - [📄 License](#-license) 25 | 26 | --- 27 | 28 | ## 📖 Overview 29 | 30 | **Enhanced Stat** is an addon suite for Godot 4.1, designed to provide an intuitive and powerful way to manage stats in games such as Health, Mana, Speed, and Attack Damage. This addon is part of the **Enhanced** suite aimed to make your Godot development faster, cleaner, and more enjoyable! 31 | 32 | --- 33 | 34 | ## 📦 Installation 35 | 36 | 1. Clone or download the repository. 37 | 2. Copy the `enhanced_stat` folder inside your project's `addons` directory. 38 | 3. Enable the addon by going to `Project -> Project Settings -> Plugins` and activating the "Enhanced Stat" plugin. 39 | 40 | --- 41 | 42 | ## 🚀 Features 43 | 44 | ### 📈 Stats 45 | 46 | - **Reactive Programming**: Stats are reactive, and changes can be listened to in real-time. 47 | - **Computed Stats**: Type safe basic stats. 48 | - **Aggregated Stats**: Create new stats based on existing stats, automatically updating when dependencies change. 49 | - **Bind Mechanism**: Allows easy binding of stats to in game nodes. 50 | - **Modifiers**: Flexible modification of stats through addition, multiplication, or other custom methods. 51 | - **Listeners**: Events to notify game logic of stats changes. 52 | 53 | ### ⚡ Status Effects 54 | 55 | - **Component-based**: Reusable components that can be combined to create complex status effects. 56 | - **Modifiers**: Attachable to stats to create temporary or permanent changes. 57 | - **Vfx**: Add vfxs or nodes while the status effect is active. 58 | 59 | ### 💻 Editor Friendly 60 | 61 | - **Editor Inspector**: Use the editor to configure the stats and status effects for your game. 62 | 63 | --- 64 | 65 | ## 🔗 Dependencies 66 | 67 | - **Enhanced Common**: This addon depends on the [enhanced_common](https://github.com/Zennyth/EnhancedCommon) addon for various utilities and common functionalities. Make sure to also have this addon installed and enabled. 68 | 69 | --- 70 | 71 | ## 📁 Project Architecture 72 | 73 | Here is an overview of the project's file hierarchy: 74 | 75 | ``` 76 | - enhanced_stat 77 | +---addons 78 | +---enhanced_common 79 | +---enhanced_stat 80 | +---icons 81 | +---scenes 82 | +---editor 83 | +---stats 84 | +---bind 85 | +---listeners 86 | +---modifier 87 | +---scripts 88 | +---editor 89 | +---stats 90 | +---bind 91 | +---listeners 92 | +---modifier 93 | +---core 94 | +---stats 95 | +---bind 96 | +---listeners 97 | +---modifier 98 | +---stat 99 | +---status_effects 100 | +---components 101 | ``` 102 | 103 | --- 104 | 105 | ## 📗 Usage 106 | 107 | Check the [documentation](https://zennyth.github.io/EnhancedStat/) for tutorials, API references, and examples to get started. Usage is straightforward and can easily be integrated into your existing Godot project. 108 | 109 | --- 110 | 111 | ## 📝 Documentation 112 | 113 | Further documentation is available in the `docs` directory. 114 | You can also check the inline comments for a more detailed understanding of specific methods and functionalities. 115 | 116 | --- 117 | 118 | ## 🍻 Contributing 119 | 120 | Contributions are very welcome! Feel free to open issues or submit pull requests. 121 | 122 | --- 123 | 124 | ## 📄 License 125 | 126 | This project is licensed under the terms of the MIT license. See [LICENSE](LICENSE) for details. 127 | This project uses icons from [icons8](https://icons8.com/license). If you fancy those lovely icons, please check out their [website](https://icons8.com/icon/set/logos/material). 128 | 129 | --- 130 | 131 | Made with ❤️ for the Godot community. Happy coding! :smile: 132 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | | Version | Godot Version | Branch | Supported | 6 | | ------- | ----|-----|------------- | 7 | | 1.x | 4.x | `godot-4.x` | :white_check_mark: | 8 | 9 | ## Reporting a Vulnerability 10 | 11 | Please [raise an issue](https://github.com/zennyth/enhanced_stat/issues) in case you find a security issue. -------------------------------------------------------------------------------- /addons.jsonc: -------------------------------------------------------------------------------- 1 | // Godot addons configuration file for use with the GodotEnv tool. 2 | // See https://github.com/chickensoft-games/GodotEnv for more info. 3 | // -------------------------------------------------------------------- // 4 | // Note: this is a JSONC file, so you can use comments! 5 | // If using Rider, see https://youtrack.jetbrains.com/issue/RIDER-41716 6 | // for any issues with JSONC. 7 | // -------------------------------------------------------------------- // 8 | { 9 | "$schema": "https://chickensoft.games/schemas/addons.schema.json", 10 | "cache": "../.addons", 11 | "addons": { 12 | "enhanced_common": { 13 | "url": "https://github.com/Zennyth/EnhancedCommon", 14 | "checkout": "develop", 15 | "subfolder": "addons/enhanced_common" 16 | } 17 | } 18 | } -------------------------------------------------------------------------------- /addons/.editorconfig: -------------------------------------------------------------------------------- 1 | # Editor configs in nested directories override those in parent directories 2 | # for the directory in which they are placed. 3 | # 4 | # This editor config prevents the code editor from analyzing C# files which 5 | # belong to addons. 6 | # 7 | # Ignoring C# addon scripts is generally preferable, since C# can be coded 8 | # in a variety of ways that may or may not trigger warnings based on your 9 | # own editorconfig or IDE settings. 10 | 11 | [*.cs] 12 | generated_code = true -------------------------------------------------------------------------------- /addons/enhanced_stat/icons/ecg_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/addons/enhanced_stat/icons/ecg_icon.png -------------------------------------------------------------------------------- /addons/enhanced_stat/icons/icons8-square-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/addons/enhanced_stat/icons/icons8-square-24.png -------------------------------------------------------------------------------- /addons/enhanced_stat/icons/icons8-stats-24 (1).png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/addons/enhanced_stat/icons/icons8-stats-24 (1).png -------------------------------------------------------------------------------- /addons/enhanced_stat/icons/icons8-stats-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/addons/enhanced_stat/icons/icons8-stats-24.png -------------------------------------------------------------------------------- /addons/enhanced_stat/icons/icons8-system-task-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/addons/enhanced_stat/icons/icons8-system-task-24.png -------------------------------------------------------------------------------- /addons/enhanced_stat/icons/pulse_icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/addons/enhanced_stat/icons/pulse_icon.png -------------------------------------------------------------------------------- /addons/enhanced_stat/plugin.cfg: -------------------------------------------------------------------------------- 1 | [plugin] 2 | 3 | name="EnhancedStat" 4 | description="Enhanced Stat is an addon suite for Godot 4.1, designed to provide an intuitive and powerful way to manage stats in games such as Health, Mana, Speed, and Attack Damage. This addon is part of the Enhanced suite aimed to make your Godot development faster, cleaner, and more enjoyable!" 5 | author="Zennyth" 6 | version="0.0.2" 7 | script="plugin.gd" 8 | -------------------------------------------------------------------------------- /addons/enhanced_stat/plugin.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | extends EditorPlugin 3 | 4 | 5 | const StatModifierEditorInspector = preload("res://addons/enhanced_stat/scripts/editor/stats/modifiers/stat_modifier_editor.gd") 6 | var stat_modifier_editor_inspector: StatModifierEditorInspector 7 | 8 | const StatBindEditorInspector = preload("res://addons/enhanced_stat/scripts/editor/stats/bind/stat_bind_editor.gd") 9 | var stat_bind_editor_inspector: StatBindEditorInspector 10 | 11 | const StatListenerEditorInspector = preload("res://addons/enhanced_stat/scripts/editor/stats/listeners/stat_listener_editor.gd") 12 | var stat_listener_editor_inspector: StatListenerEditorInspector 13 | 14 | func _enter_tree(): 15 | stat_modifier_editor_inspector = StatModifierEditorInspector.new() 16 | add_inspector_plugin(stat_modifier_editor_inspector) 17 | 18 | stat_bind_editor_inspector = StatBindEditorInspector.new() 19 | add_inspector_plugin(stat_bind_editor_inspector) 20 | 21 | stat_listener_editor_inspector = StatListenerEditorInspector.new() 22 | add_inspector_plugin(stat_listener_editor_inspector) 23 | 24 | func _exit_tree(): 25 | remove_inspector_plugin(stat_modifier_editor_inspector) 26 | remove_inspector_plugin(stat_bind_editor_inspector) 27 | remove_inspector_plugin(stat_listener_editor_inspector) -------------------------------------------------------------------------------- /addons/enhanced_stat/scenes/editor/stats/bind/StatBindKeyButton.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=2 format=3 uid="uid://1pf1oqyag73b"] 2 | 3 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/editor/stats/bind/stat_bind_key_button.gd" id="1_vib5v"] 4 | 5 | [node name="OptionButton" type="OptionButton"] 6 | offset_left = 638.0 7 | offset_right = 1272.0 8 | offset_bottom = 720.0 9 | size_flags_horizontal = 3 10 | theme_override_colors/font_color = Color(1, 1, 1, 1) 11 | text_overrun_behavior = 3 12 | fit_to_longest_item = false 13 | script = ExtResource("1_vib5v") 14 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scenes/editor/stats/bind/StatBindPropertyButton.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=2 format=3 uid="uid://cnxrnpb1eur4m"] 2 | 3 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/editor/stats/bind/stat_bind_property_button.gd" id="1_jsuxr"] 4 | 5 | [node name="OptionButton" type="OptionButton"] 6 | offset_left = 638.0 7 | offset_right = 1272.0 8 | offset_bottom = 720.0 9 | size_flags_horizontal = 3 10 | theme_override_colors/font_color = Color(1, 1, 1, 1) 11 | text_overrun_behavior = 3 12 | fit_to_longest_item = false 13 | script = ExtResource("1_jsuxr") 14 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scenes/editor/stats/listeners/StatListenerButton.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=2 format=3 uid="uid://b0mu6ixl6ymjn"] 2 | 3 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/editor/stats/listeners/stat_listener_button.gd" id="1_68eqh"] 4 | 5 | [node name="OptionButton" type="OptionButton"] 6 | offset_left = 638.0 7 | offset_right = 1272.0 8 | offset_bottom = 720.0 9 | size_flags_horizontal = 3 10 | theme_override_colors/font_color = Color(1, 1, 1, 1) 11 | text_overrun_behavior = 3 12 | fit_to_longest_item = false 13 | script = ExtResource("1_68eqh") 14 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scenes/editor/stats/modifiers/StatModifierButton.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=2 format=3 uid="uid://b0mu6ixl6ymjn"] 2 | 3 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/editor/stats/modifiers/stat_modifier_button.gd" id="1_68eqh"] 4 | 5 | [node name="OptionButton" type="OptionButton"] 6 | offset_left = 638.0 7 | offset_right = 1272.0 8 | offset_bottom = 720.0 9 | size_flags_horizontal = 3 10 | theme_override_colors/font_color = Color(1, 1, 1, 1) 11 | text_overrun_behavior = 3 12 | fit_to_longest_item = false 13 | script = ExtResource("1_68eqh") 14 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/bind/abstract_stat_bind.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | @icon("res://addons/enhanced_stat/icons/icons8-stats-24.png") 3 | extends Node 4 | class_name AbstractStatBind 5 | 6 | enum Mode { 7 | BIND_STAT, 8 | BIND_VALUE, 9 | } 10 | 11 | @export var mode: Mode = Mode.BIND_STAT 12 | @export var target: Node: 13 | set(value): 14 | target = value 15 | notify_property_list_changed() 16 | @export var stat_key: GDScript 17 | @export var property_to_bind: String 18 | 19 | 20 | var _on_stat_value_changed 21 | var _stats_manager: StatsManager: 22 | get = get_stats_manager 23 | 24 | func get_stats_manager() -> StatsManager: 25 | return null 26 | 27 | 28 | func _ready() -> void: 29 | if Engine.is_editor_hint(): 30 | return 31 | 32 | bind() 33 | 34 | func bind() -> void: 35 | if mode == Mode.BIND_STAT: 36 | StatUtils.bind_stat(target, property_to_bind, stat_key, _stats_manager) 37 | elif mode == Mode.BIND_VALUE: 38 | _on_stat_value_changed = StatUtils.bind_stat_value(target, property_to_bind, stat_key, _stats_manager) 39 | 40 | func unbind() -> void: 41 | if mode == Mode.BIND_STAT: 42 | StatUtils.unbind_stat(target, property_to_bind) 43 | elif mode == Mode.BIND_VALUE: 44 | StatUtils.unbind_stat_value(target, property_to_bind, _on_stat_value_changed) 45 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/bind/stat_bind.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | extends AbstractStatBind 3 | class_name StatBind 4 | 5 | @export var stats_manager: StatsManager: 6 | set(value): 7 | stats_manager = value 8 | notify_property_list_changed() 9 | 10 | func get_stats_manager() -> StatsManager: 11 | return stats_manager -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/listeners/stat_listener.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_common/icons/icons8-trigger-24.png") 2 | extends Node 3 | class_name StatListener 4 | 5 | signal triggered 6 | 7 | @export var stats_manager: StatsManager 8 | @export var stat_key: GDScript 9 | @export var signal_name: String 10 | 11 | func _ready() -> void: 12 | if stats_manager == null or stat_key == null or signal_name == null: 13 | return 14 | 15 | var stat: Stat = stats_manager.get_stat(stat_key) 16 | 17 | if stat == null or !stat.has_signal(signal_name): 18 | return 19 | 20 | stat.get(signal_name).connect(_on_triggered) 21 | 22 | func _on_triggered(arg1 = null, arg2 = null, arg3 = null, arg4 = null) -> void: 23 | triggered.emit() 24 | 25 | 26 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/aggregated/_aggregated_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends StatModifier 2 | class_name AggregatedStatModifier 3 | 4 | 5 | func set_apply_count(value: int) -> void: 6 | super(value) 7 | 8 | for stat_modifier in stat_modifiers: 9 | stat_modifier.apply_count = apply_count 10 | 11 | 12 | 13 | var stat_modifiers: Array[StatModifier]: 14 | get = get_stat_modifiers 15 | 16 | func get_stat_modifiers() -> Array[StatModifier]: 17 | var res: Array[StatModifier] = [] 18 | 19 | for property in get_property_list(): 20 | if property.usage == 4102 and get(property.name) is StatModifier: 21 | res.append(get(property.name) as StatModifier) 22 | 23 | return res -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/aggregated/pool/_pool_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends AggregatedStatModifier 2 | class_name PoolStatModifier 3 | 4 | @export var is_infinite: BoolStatModifier -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/aggregated/pool/float_pool_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends PoolStatModifier 2 | class_name FloatPoolStatModifier 3 | 4 | @export var max: FloatStatModifier 5 | @export var min: FloatStatModifier -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/aggregated/pool/int_pool_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends PoolStatModifier 2 | class_name IntPoolStatModifier 3 | 4 | @export var max: IntStatModifier 5 | @export var min: IntStatModifier -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/computed/_computed_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends StatModifier 2 | class_name ComputedStatModifier 3 | 4 | func apply(_value, _stat): 5 | return null -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/computed/bool_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends ComputedStatModifier 2 | class_name BoolStatModifier 3 | 4 | @export var new_value: bool = false 5 | 6 | func apply(_value: bool, _stat: BoolStat): 7 | return new_value if apply_count > 0 else _value -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/computed/number/_number_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends ComputedStatModifier 2 | class_name NumberStatModifier 3 | 4 | enum Operation { 5 | ADD, 6 | SUBSTRACT, 7 | MULTIPLY, 8 | DIVIDE 9 | } 10 | 11 | @export var operation: Operation = Operation.ADD 12 | 13 | var _operation_value: 14 | get = get_operation_value 15 | 16 | func get_operation_value(): 17 | return 0 18 | 19 | func apply(value, _stat): 20 | match operation: 21 | Operation.ADD: 22 | return value + (_operation_value * apply_count) 23 | Operation.SUBSTRACT: 24 | return value - (_operation_value * apply_count) 25 | Operation.MULTIPLY: 26 | return value * _operation_value * apply_count 27 | Operation.DIVIDE: 28 | if _operation_value == 0: 29 | push_error("NumberStatModifier cannot divide by 0") 30 | return value 31 | 32 | return value / _operation_value * apply_count 33 | 34 | return value -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/computed/number/float_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends NumberStatModifier 2 | class_name FloatStatModifier 3 | 4 | @export var operation_value: float = 0 5 | 6 | func get_operation_value() -> float: 7 | return operation_value 8 | 9 | func apply(value: float, stat: FloatStat): 10 | return super(value, stat) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/computed/number/int_stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends NumberStatModifier 2 | class_name IntStatModifier 3 | 4 | @export var operation_value: int = 0 5 | 6 | func get_operation_value() -> int: 7 | return operation_value 8 | 9 | func apply(value: int, stat: IntStat): 10 | return super(value, stat) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/modifiers/stat_modifier.gd: -------------------------------------------------------------------------------- 1 | extends Resource 2 | class_name StatModifier 3 | 4 | signal apply_count_changed() 5 | 6 | 7 | @export var stat_key: GDScript 8 | @export var apply_count: int = 1: 9 | set = set_apply_count 10 | 11 | func set_apply_count(value: int) -> void: 12 | apply_count = value 13 | apply_count_changed.emit() 14 | 15 | 16 | func compatible_with(stat: Stat) -> bool: 17 | return stat_key == stat.key -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/_aggregated_stat.gd: -------------------------------------------------------------------------------- 1 | extends Stat 2 | class_name AggregatedStat 3 | 4 | 5 | ### 6 | # CORE 7 | ### 8 | var _value: 9 | set = set_value 10 | 11 | func get_value(): 12 | return _value 13 | 14 | func set_value(new_value): 15 | var is_different: bool = new_value != _value 16 | _value = new_value 17 | 18 | if is_different: 19 | value_changed.emit() 20 | 21 | 22 | ### 23 | # STAT MODIFIERS 24 | ### 25 | var internal_stats: Array[Stat]: 26 | get = get_internal_stats 27 | 28 | func get_internal_stats() -> Array[Stat]: 29 | var res: Array[Stat] = [] 30 | 31 | for property in get_property_list(): 32 | if property.usage == 4102 and get(property.name) is Stat: 33 | res.append(get(property.name) as Stat) 34 | 35 | return res 36 | 37 | 38 | func add_stat_modifier(stat_modifier: StatModifier) -> void: 39 | for property in stat_modifier.get_property_list(): 40 | if !property.name in self or !get(property.name) is Stat or stat_modifier.get(property.name) == null: 41 | continue 42 | 43 | get(property.name).add_stat_modifier(stat_modifier.get(property.name)) 44 | 45 | func remove_stat_modifier(stat_modifier: StatModifier) -> void: 46 | for property in stat_modifier.get_property_list(): 47 | if !property.name in self or !get(property.name) is Stat: 48 | continue 49 | 50 | get(property.name).remove_stat_modifier(stat_modifier.get(property.name)) 51 | 52 | func clear_stat_modifiers() -> void: 53 | for internal_stat in internal_stats: 54 | internal_stat.clear_stat_modifiers() 55 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/pool/_pool_stat.gd: -------------------------------------------------------------------------------- 1 | extends AggregatedStat 2 | class_name PoolStat 3 | 4 | signal depleted() 5 | signal replenished() 6 | signal increased(value, amount) 7 | signal decreased(value, amount) 8 | 9 | 10 | var _max: NumberStat 11 | var _min: NumberStat 12 | @export var is_infinite: BoolStat 13 | 14 | 15 | func _on_max_increased(_max_value, increase_amount) -> void: 16 | _value += increase_amount 17 | 18 | func _on_max_decreased(_max_value, _decrease_amount) -> void: 19 | _value = _value 20 | 21 | 22 | func initialize() -> void: 23 | if base_value == -1: 24 | base_value = _max.value 25 | 26 | _value = base_value 27 | SignalUtils.connect_if_not_connected(_max.increased, _on_max_increased) 28 | SignalUtils.connect_if_not_connected(_max.decreased, _on_max_decreased) 29 | # SignalUtils.connect_if_not_connected(_min.value_changed, update_value) 30 | 31 | func set_default_value(_default_value) -> void: 32 | base_value = _default_value 33 | 34 | if _max == null or _min == null: 35 | return 36 | 37 | initialize() 38 | 39 | func set_value(new_value) -> void: 40 | if is_infinite != null and is_infinite.value: 41 | return 42 | 43 | var previous = _value 44 | new_value = min(new_value, _max.value) 45 | new_value = max(new_value, _min.value) 46 | 47 | super(new_value) 48 | 49 | if previous == null: 50 | return 51 | 52 | var amount = _value - previous 53 | if amount > 0: 54 | increased.emit(new_value, amount) 55 | elif amount < 0: 56 | decreased.emit(new_value, amount) 57 | else: 58 | return 59 | 60 | if is_empty(): 61 | depleted.emit() 62 | elif is_full(): 63 | replenished.emit() 64 | 65 | 66 | func decrease(to_decrease) -> void: 67 | _value -= to_decrease 68 | 69 | func increase(to_increase) -> void: 70 | _value += to_increase 71 | 72 | func replenish() -> void: 73 | _value = _max.value 74 | 75 | func deplete() -> void: 76 | _value = _min.value 77 | 78 | 79 | func is_full() -> bool: 80 | return _max.value == _value 81 | 82 | func is_empty() -> bool: 83 | return _min.value == _value 84 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/pool/float_pool_stat.gd: -------------------------------------------------------------------------------- 1 | extends PoolStat 2 | class_name FloatPoolStat 3 | 4 | 5 | @export var max: FloatStat = FloatStat.new(): 6 | set(_max_value): 7 | max = _max_value 8 | _max = max 9 | set_default_value(default_value) 10 | 11 | @export var min: FloatStat = FloatStat.new(): 12 | set(_min_value): 13 | min = _min_value 14 | _min = min 15 | set_default_value(default_value) 16 | 17 | @export var default_value: float = 0: 18 | set(_default_value): 19 | default_value = _default_value 20 | set_default_value(default_value) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/pool/growable/_growable_pool_stat.gd: -------------------------------------------------------------------------------- 1 | extends PoolStat 2 | class_name GrowablePoolStat 3 | 4 | signal leveled_up 5 | 6 | @export var level: int = 1 7 | 8 | func grow() -> void: 9 | pass 10 | 11 | func set_value(new_value) -> void: 12 | if _value == null or new_value < _max.value: 13 | return super(new_value) 14 | 15 | var difference = new_value - _max.value 16 | grow() 17 | level += 1 18 | value_changed.emit() 19 | leveled_up.emit() 20 | set_value(difference) 21 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/pool/growable/float_growable_pool_stat.gd: -------------------------------------------------------------------------------- 1 | extends GrowablePoolStat 2 | class_name FloatGrowablePoolStat 3 | 4 | 5 | @export var max: FloatStat = FloatStat.new(): 6 | set(_max_value): 7 | max = _max_value 8 | _max = max 9 | 10 | @export var min: FloatStat = FloatStat.new(): 11 | set(_min_value): 12 | min = _min_value 13 | _min = min 14 | 15 | @export var default_value: float = 0: 16 | set(_default_value): 17 | default_value = _default_value 18 | set_default_value(default_value) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/pool/growable/int_growable_pool_stat.gd: -------------------------------------------------------------------------------- 1 | extends GrowablePoolStat 2 | class_name IntGrowablePoolStat 3 | 4 | 5 | @export var max: IntStat = IntStat.new(): 6 | set(_max_value): 7 | max = _max_value 8 | _max = max 9 | 10 | @export var min: IntStat = IntStat.new(): 11 | set(_min_value): 12 | min = _min_value 13 | _min = min 14 | 15 | @export var default_value: int = 0: 16 | set(_default_value): 17 | default_value = _default_value 18 | set_default_value(default_value) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/aggregated/pool/int_pool_stat.gd: -------------------------------------------------------------------------------- 1 | extends PoolStat 2 | class_name IntPoolStat 3 | 4 | 5 | @export var max: IntStat = IntStat.new(): 6 | set(_max_value): 7 | max = _max_value 8 | _max = max 9 | set_default_value(default_value) 10 | 11 | @export var min: IntStat = IntStat.new(): 12 | set(_min_value): 13 | min = _min_value 14 | _min = min 15 | set_default_value(default_value) 16 | 17 | @export var default_value: int = -1: 18 | set(_default_value): 19 | default_value = _default_value 20 | set_default_value(default_value) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/computed/_computed_stat.gd: -------------------------------------------------------------------------------- 1 | extends Stat 2 | class_name ComputedStat 3 | 4 | 5 | ### 6 | # CORE 7 | ### 8 | var _value 9 | 10 | func get_value(): 11 | return _value 12 | 13 | func compute() -> void: 14 | var computed = base_value 15 | 16 | for stat_modifier in stat_modifiers: 17 | computed = stat_modifier.apply(computed, self) 18 | 19 | _value = computed 20 | value_changed.emit() 21 | 22 | 23 | ### 24 | # STAT MODIFIERS 25 | ### 26 | var stat_modifiers: Array[StatModifier] = [] 27 | 28 | func add_stat_modifier(stat_modifier: StatModifier) -> void: 29 | stat_modifiers.append(stat_modifier) 30 | stat_modifier.apply_count_changed.connect(compute) 31 | compute() 32 | 33 | func remove_stat_modifier(stat_modifier: StatModifier) -> void: 34 | stat_modifiers.erase(stat_modifier) 35 | stat_modifier.apply_count_changed.disconnect(compute) 36 | compute() 37 | 38 | func clear_stat_modifiers() -> void: 39 | for stat_modifier in stat_modifiers: 40 | stat_modifier.apply_count_changed.disconnect(compute) 41 | 42 | stat_modifiers = [] 43 | compute() 44 | 45 | 46 | 47 | ### 48 | # CONSTRUCTOR 49 | ### 50 | func _init(_base_value = base_value) -> void: 51 | base_value = _base_value 52 | compute() 53 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/computed/bool_stat.gd: -------------------------------------------------------------------------------- 1 | extends ComputedStat 2 | class_name BoolStat 3 | 4 | @export var default_value: bool = false: 5 | set(_default_value): 6 | default_value = _default_value 7 | base_value = default_value 8 | _value = default_value 9 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/computed/number/_number_stat.gd: -------------------------------------------------------------------------------- 1 | extends ComputedStat 2 | class_name NumberStat 3 | 4 | signal increased(value, amount) 5 | signal decreased(value, amount) 6 | 7 | func compute() -> void: 8 | var previous = _value 9 | 10 | super() 11 | 12 | if previous == null: 13 | return 14 | 15 | var amount = _value - previous 16 | 17 | if amount > 0: 18 | increased.emit(value, amount) 19 | elif amount < 0: 20 | decreased.emit(value, amount) 21 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/computed/number/float_stat.gd: -------------------------------------------------------------------------------- 1 | extends NumberStat 2 | class_name FloatStat 3 | 4 | @export var default_value: float = .0: 5 | set(_default_value): 6 | default_value = _default_value 7 | base_value = default_value 8 | _value = default_value 9 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/computed/number/int_stat.gd: -------------------------------------------------------------------------------- 1 | extends NumberStat 2 | class_name IntStat 3 | 4 | @export var default_value: int = 0: 5 | set(_default_value): 6 | default_value = _default_value 7 | base_value = default_value 8 | _value = default_value 9 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stat/stat.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_common/icons/icons8-stats-24.png") 2 | extends Resource 3 | class_name Stat 4 | ## The Stat class is used for representing individual stats, like Health, Mana, Speed, etc. 5 | ## 6 | ## As it inherits from Godot's Resource, it is easily serializable and can be shared among multiple instances or saved for later. 7 | 8 | ### 9 | # CORE 10 | ### 11 | 12 | ## Key that defines the uniqueness of a stat 13 | var key: Variant: 14 | get = get_key 15 | 16 | ## Get the key 17 | func get_key() -> Variant: 18 | return get_script() 19 | 20 | ## 21 | signal value_changed 22 | 23 | var value: 24 | get = get_value 25 | 26 | func get_value(): 27 | return base_value 28 | 29 | 30 | var base_value 31 | 32 | 33 | ### 34 | # STAT MODIFIERS 35 | ### 36 | func add_stat_modifier(stat_modifier) -> void: 37 | pass 38 | 39 | func remove_stat_modifier(stat_modifier) -> void: 40 | pass 41 | 42 | func clear_stat_modifiers() -> void: 43 | pass -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stats.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_common/icons/icons8-stats-24 (1).png") 2 | extends Resource 3 | class_name Stats 4 | ## The Stats class is essentially a container for Stat objects. 5 | ## 6 | ## It is useful when you have an entity that has multiple stats, 7 | ## like a character in an RPG who has health, mana, strength, etc. 8 | 9 | 10 | ### 11 | # STATS 12 | ### 13 | 14 | ## Dictionary that holds a look up for (key, stat) 15 | var map: Dictionary: 16 | get = get_map_from_list 17 | 18 | ## Generate the look up table from a list of stat 19 | func get_map_from_list() -> Dictionary: 20 | var new_map = {} 21 | 22 | for property in get_property_list(): 23 | # if not exported 24 | if property.get("usage") != 4102: 25 | continue 26 | 27 | var stat = get(property.get("name")) 28 | 29 | if not stat is Stat: 30 | continue 31 | 32 | if stat.key in new_map: 33 | push_warning("Found duplicate key: ", stat.key, " in stats: ", self) 34 | continue 35 | 36 | new_map[stat.key] = stat 37 | 38 | return new_map 39 | 40 | ## Get the look up table as an array 41 | func get_stats() -> Array: 42 | return map.values() 43 | 44 | ## Get a specific stat by it's key 45 | func get_stat(key) -> Stat: 46 | return map[key] if key in map else null 47 | 48 | ## Check whether the key is in the look up table 49 | func has_stat(key) -> bool: 50 | return map.has(key) 51 | 52 | 53 | 54 | ### 55 | # STAT MODIFIERS 56 | ### 57 | 58 | ## Add a stat modifier to a stat 59 | func add_stat_modifier(stat_modifier: StatModifier) -> void: 60 | var stat: Stat = get_stat(stat_modifier.stat_key) 61 | 62 | if stat == null: 63 | return 64 | 65 | stat.add_stat_modifier(stat_modifier) 66 | 67 | ## Remove a stat modifier from a stat 68 | func remove_stat_modifier(stat_modifier: StatModifier) -> void: 69 | var stat: Stat = get_stat(stat_modifier.stat_key) 70 | 71 | if stat == null: 72 | return 73 | 74 | stat.remove_stat_modifier(stat_modifier) 75 | 76 | ## Clear all stat modifiers from all stats 77 | func clear_stat_modifiers() -> void: 78 | for stat in get_stats(): 79 | stat.clear_stat_modifiers() -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/stats/stats_manager.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | @icon("res://addons/enhanced_stat/icons/icons8-stats-24 (1).png") 3 | extends Node 4 | class_name StatsManager 5 | ## The StatsManager class provides an interface to manage Stats and is typically attached to the entity that owns those stats. 6 | ## This makes it easier to access and manipulate stats during gameplay. 7 | 8 | ## Stats holder 9 | var stats: Stats: 10 | set = set_stats 11 | 12 | var _stats: Stats 13 | 14 | func set_stats(value) -> void: 15 | stats = value 16 | 17 | if stats == null: 18 | return 19 | 20 | _stats = stats.duplicate(true) 21 | initialize_replication() 22 | 23 | ## Get a specific stat by it's key 24 | func get_stat(key: Variant) -> Stat: 25 | return _stats.get_stat(key) if _stats != null else null 26 | 27 | 28 | 29 | ### 30 | # STAT MODIFIERS 31 | ### 32 | 33 | ## Add a stat modifier to a stat 34 | func add_stat_modifier(stat_modifier: StatModifier) -> void: 35 | if _stats == null: 36 | return 37 | 38 | _stats.add_stat_modifier(stat_modifier) 39 | 40 | ## Remove a stat modifier from a stat 41 | func remove_stat_modifier(stat_modifier: StatModifier) -> void: 42 | if _stats == null: 43 | return 44 | 45 | _stats.remove_stat_modifier(stat_modifier) 46 | 47 | ## Clear all stat modifiers from all stats 48 | func clear_stat_modifiers() -> void: 49 | if _stats == null: 50 | return 51 | 52 | _stats.clear_stat_modifiers() 53 | 54 | 55 | ### 56 | # MULTIPLAYER (Experimental) 57 | # TODO: Make this a component to attach to a StatsManager 58 | ### 59 | func _ready() -> void: 60 | if !is_multiplayer_authority(): 61 | return 62 | 63 | initialize_replication() 64 | 65 | var is_replication_enabled: bool = false 66 | 67 | ## Initialize the replication of all stats to all peers 68 | func initialize_replication() -> void: 69 | if Engine.is_editor_hint(): 70 | return 71 | 72 | if is_replication_enabled == true or !is_node_ready(): 73 | return 74 | 75 | if _stats == null: 76 | return 77 | 78 | for stat_key in _stats.map.keys(): 79 | _stats.get_stat(stat_key).value_changed.connect(_on_stat_value_changed.bind(stat_key, _stats.get_stat(stat_key))) 80 | 81 | is_replication_enabled = true 82 | 83 | func _on_stat_value_changed(key: GDScript, stat: Stat) -> void: 84 | sync_stat.rpc(key.resource_path, stat.value) 85 | 86 | ## Sync the stat value of a specific stat by it's key and it's current value 87 | @rpc("call_local", "any_peer") 88 | func sync_stat(key_path, value) -> void: 89 | var key: GDScript = load(key_path) 90 | var stat: Stat = get_stat(key) 91 | 92 | if stat: 93 | stat.value = value 94 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/components/_status_effect_component.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_stat/icons/icons8-square-24.png") 2 | extends "res://addons/enhanced_stat/scripts/core/status_effects/status_effect_abstract.gd" 3 | class_name StatusEffectComponent 4 | 5 | func _enable() -> void: 6 | pass 7 | 8 | func _disable() -> void: 9 | pass 10 | 11 | func _tick() -> void: 12 | pass 13 | 14 | func get_intensity() -> float: 15 | return 0. -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/components/stat_modifier_status_effect_component.gd: -------------------------------------------------------------------------------- 1 | extends StatusEffectComponent 2 | class_name StatModifierStatusEffectComponent 3 | 4 | @export var stat_modifiers: Array[StatModifier] = [] 5 | 6 | 7 | var stat_manager: StatsManager 8 | 9 | func _enable() -> void: 10 | stat_manager = get_target_component(StatsManager) 11 | 12 | if stat_manager == null: 13 | return 14 | 15 | for stat_modifier in stat_modifiers: 16 | stat_manager.add_stat_modifier(stat_modifier) 17 | 18 | func _disable() -> void: 19 | if stat_manager == null: 20 | return 21 | 22 | for stat_modifier in stat_modifiers: 23 | stat_manager.remove_stat_modifier(stat_modifier) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/components/vfx_status_effect_component.gd: -------------------------------------------------------------------------------- 1 | extends StatusEffectComponent 2 | class_name VfxStatusEffectComponent 3 | 4 | @export var packed_vfx: PackedScene 5 | 6 | var vfx: Node 7 | 8 | func _enable() -> void: 9 | vfx = packed_vfx.instantiate() 10 | target.add_child(vfx) 11 | 12 | func _disable() -> void: 13 | if vfx == null: 14 | return 15 | 16 | target.remove_child(vfx) 17 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/status_effect.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_stat/icons/pulse_icon.png") 2 | extends "res://addons/enhanced_stat/scripts/core/status_effects/status_effect_abstract.gd" 3 | class_name StatusEffect 4 | 5 | signal _enabled 6 | signal _disabled 7 | 8 | 9 | @export var id: String 10 | 11 | var intensity: float: 12 | get = get_intensity 13 | 14 | func get_intensity() -> float: 15 | return 0. 16 | 17 | 18 | 19 | var is_enabled: bool = false 20 | 21 | @export var duration: float = 1. 22 | 23 | var _duration: float: 24 | set = set_duration 25 | 26 | func set_duration(value) -> void: 27 | _duration = value 28 | 29 | if _duration <= 0: 30 | disable() 31 | 32 | func reset() -> void: 33 | _duration = duration 34 | 35 | 36 | @export var tick_interval: float = 1. 37 | 38 | var tick_clock: float = .0 39 | 40 | 41 | @export var status_effect_components: Array[StatusEffectComponent] = [] 42 | var initial_status_effect_components: Array[StatusEffectComponent] = [] 43 | 44 | 45 | func is_target_valid(_target: Node) -> bool: 46 | return true 47 | 48 | func set_target(value) -> void: 49 | if not is_target_valid(value): 50 | return 51 | 52 | target = value 53 | 54 | 55 | func enable() -> void: 56 | if not is_target_valid(target): 57 | return 58 | 59 | is_enabled = true 60 | reset() 61 | _enable() 62 | _enabled.emit() 63 | 64 | func disable() -> void: 65 | if not is_enabled: 66 | return 67 | 68 | is_enabled = false 69 | _disable() 70 | _disabled.emit() 71 | 72 | func tick(delta: float) -> void: 73 | if not is_enabled: 74 | return 75 | 76 | _duration -= delta 77 | 78 | if tick_interval == 0: 79 | return _tick() 80 | 81 | if tick_interval <= -1: 82 | return 83 | 84 | tick_clock += delta 85 | 86 | if tick_clock < tick_interval: 87 | return 88 | 89 | tick_clock -= tick_interval 90 | _tick() 91 | 92 | 93 | func _enable() -> void: 94 | for status_effect_component in status_effect_components: 95 | var initial_status_effect_component = status_effect_component.duplicate(true) 96 | initial_status_effect_component.target = target 97 | initial_status_effect_component._enable() 98 | initial_status_effect_components.append(initial_status_effect_component) 99 | 100 | func _disable() -> void: 101 | for status_effect_component in initial_status_effect_components: 102 | status_effect_component._disable() 103 | 104 | func _tick() -> void: 105 | for status_effect_component in initial_status_effect_components: 106 | status_effect_component._tick() 107 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/status_effect_abstract.gd: -------------------------------------------------------------------------------- 1 | extends Resource 2 | 3 | var target: Node: 4 | set = set_target 5 | 6 | func set_target(value) -> void: 7 | target = value 8 | 9 | func _enable() -> void: 10 | pass 11 | 12 | func _disable() -> void: 13 | pass 14 | 15 | func _tick() -> void: 16 | pass 17 | 18 | func get_intensity() -> float: 19 | return 0. 20 | 21 | 22 | func get_target_component(component_class): 23 | return NodeUtils.find_node(target, component_class) 24 | 25 | func get_target_stat(stat_class): 26 | return NodeUtils.find_node(target, StatsManager).get_stat(stat_class) 27 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/status_effect_applier.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_stat/icons/ecg_icon.png") 2 | extends Node 3 | class_name StatusEffectApplier 4 | 5 | @export var status_effects: Array[StatusEffect] = [] 6 | 7 | func apply(target: Node) -> void: 8 | var status_effect_manager: StatusEffectManager = NodeUtils.find_node(target, StatusEffectManager) 9 | 10 | if status_effect_manager == null or status_effects == null: 11 | return 12 | 13 | for status_effect in status_effects: 14 | var instance: StatusEffect = status_effect.duplicate() 15 | instance.target = target 16 | 17 | status_effect_manager.add_status_effect(instance) 18 | 19 | 20 | 21 | func remove(target: Node) -> void: 22 | var status_effect_manager: StatusEffectManager = NodeUtils.find_node(target, StatusEffectManager) 23 | 24 | if status_effect_manager == null or status_effects == null: 25 | return 26 | 27 | for status_effect in status_effects: 28 | var instance: StatusEffect = status_effect.duplicate() 29 | 30 | status_effect_manager.remove_status_effect(instance) 31 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/core/status_effects/status_effect_manager.gd: -------------------------------------------------------------------------------- 1 | @icon("res://addons/enhanced_stat/icons/icons8-system-task-24.png") 2 | extends Node 3 | class_name StatusEffectManager 4 | 5 | signal _status_effect_added(status_effect: StatusEffect) 6 | signal _status_effect_removed(status_effect: StatusEffect) 7 | 8 | 9 | var status_effects: Dictionary = {} 10 | 11 | func add_status_effect(status_effect: StatusEffect) -> void: 12 | if status_effect == null: 13 | return 14 | 15 | if status_effects.has(status_effect.id): 16 | var current_status_effect = status_effects[status_effect.id] 17 | 18 | if status_effect.intensity == current_status_effect.intensity: 19 | status_effects[status_effect.id].reset() 20 | return 21 | 22 | if status_effect.intensity < current_status_effect.intensity: 23 | return 24 | 25 | remove_status_effect(current_status_effect) 26 | 27 | status_effects[status_effect.id] = status_effect 28 | status_effect.enable() 29 | status_effect._disabled.connect(remove_status_effect.bind(status_effect), CONNECT_ONE_SHOT) 30 | _status_effect_added.emit(status_effect) 31 | 32 | func remove_status_effect(status_effect: StatusEffect) -> void: 33 | if status_effect == null: 34 | return 35 | 36 | if not status_effects.has(status_effect.id): 37 | return 38 | 39 | status_effect.disable() 40 | status_effects.erase(status_effect.id) 41 | _status_effect_removed.emit(status_effect) 42 | 43 | func clear_status_effects() -> void: 44 | for status_effect in status_effects.values(): 45 | remove_status_effect(status_effect) 46 | 47 | 48 | func _physics_process(delta: float) -> void: 49 | for status_effect in status_effects.values(): 50 | status_effect.tick(delta) 51 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/editor/stats/bind/stat_bind_editor.gd: -------------------------------------------------------------------------------- 1 | extends EnhancedEditorInspectorPlugin 2 | 3 | 4 | func _can_handle(object: Object) -> bool: 5 | return object is AbstractStatBind 6 | 7 | func _parse_property(object: Object, type: Variant.Type, name: String, hint_type: PropertyHint, hint_string: String, usage_flags: int, wide: bool) -> bool: 8 | if name == "stat_key": 9 | var button = OptionProperties.new() 10 | button.initialize(object, name, _get_stats(object)) 11 | add_custom_editor_inspector_container("Stat", button) 12 | return true 13 | 14 | if name == "property_to_bind": 15 | var button = OptionProperties.new() 16 | button.initialize(object, name, _get_properties(object)) 17 | add_custom_editor_inspector_container("Property to bind", button) 18 | return true 19 | 20 | return false 21 | 22 | func _get_stats(stat_bind: AbstractStatBind) -> Array[Dictionary]: 23 | if stat_bind == null or stat_bind._stats_manager == null: 24 | return [] 25 | 26 | var properties: Array[Dictionary] = [] 27 | 28 | for property in ClassUtils.get_custom_classes_from_exported_properties(stat_bind._stats_manager).filter(func(p): return p.name == "stats"): 29 | for custom_class in ClassUtils.get_custom_classes_from_custom_class(property.hint_string): 30 | properties.append({ 31 | "name": custom_class.class.replace("Stat", ""), 32 | "icon": custom_class.icon, 33 | "value": load(custom_class.path) 34 | }) 35 | 36 | return properties 37 | 38 | func _get_properties(stat_bind: AbstractStatBind) -> Array[Dictionary]: 39 | if stat_bind == null or stat_bind.target == null: 40 | return [] 41 | 42 | var properties: Array[Dictionary] = [] 43 | 44 | for property in stat_bind.target.get_property_list().filter(func(p: Dictionary): return !p.name.contains(".gd")): 45 | properties.append({ 46 | "name": property.name, 47 | "value": property.name 48 | }) 49 | 50 | properties.reverse() 51 | return properties -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/editor/stats/listeners/stat_listener_button.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | extends OptionButton 3 | 4 | 5 | var stat_listener: StatListener 6 | 7 | func initialize(_stat_listener: StatListener) -> void: 8 | stat_listener = _stat_listener 9 | 10 | 11 | var items: Array[Dictionary] = [] 12 | 13 | func _ready() -> void: 14 | if stat_listener == null or stat_listener._stats_manager == null: 15 | return 16 | 17 | item_selected.connect(_on_item_selected) 18 | 19 | for property in ClassUtils.get_custom_classes_from_exported_properties(stat_listener._stats_manager): 20 | if property.name != "stats": 21 | continue 22 | 23 | var classes := ClassUtils.get_custom_classes_from_custom_class(property.hint_string) 24 | 25 | for i in len(classes): 26 | var custom_class = classes[i] 27 | var custom_class_name = custom_class.class.replace("Stat", "") 28 | add_item(custom_class_name, i) if custom_class.icon == "" else add_icon_item(load(custom_class.icon) as Texture2D, custom_class_name, i) 29 | items.append(custom_class) 30 | 31 | if stat_listener.stat_key != null and stat_listener.stat_key.resource_path == custom_class.path: 32 | select(i) 33 | 34 | 35 | 36 | 37 | func _on_item_selected(index: int) -> void: 38 | var custom_class: Dictionary = items[index] 39 | stat_listener.stat_key = load(custom_class.path) -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/editor/stats/listeners/stat_listener_editor.gd: -------------------------------------------------------------------------------- 1 | extends EnhancedEditorInspectorPlugin 2 | 3 | const StatListenerButton = preload("res://addons/enhanced_stat/scenes/editor/stats/listeners/StatListenerButton.tscn") 4 | 5 | func _can_handle(object: Object) -> bool: 6 | return object is StatListener 7 | 8 | 9 | func _parse_property(object: Object, type: Variant.Type, name: String, hint_type: PropertyHint, hint_string: String, usage_flags: int, wide: bool) -> bool: 10 | if name == "stat_key": 11 | var button = StatListenerButton.instantiate() 12 | button.initialize(object) 13 | add_custom_editor_inspector_container("Stat", button) 14 | return true 15 | 16 | return false -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/editor/stats/modifiers/stat_modifier_button.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | extends OptionButton 3 | 4 | 5 | var stat_modifier: StatModifier 6 | 7 | func initialize(_stat_modifier: StatModifier) -> void: 8 | stat_modifier = _stat_modifier 9 | 10 | 11 | var items: Array[Dictionary] = [] 12 | 13 | func _ready() -> void: 14 | if stat_modifier == null: 15 | return 16 | 17 | item_selected.connect(_on_item_selected) 18 | 19 | var custom_class_modifier: String = ClassUtils.get_custom_class(stat_modifier).class 20 | 21 | var classes := ClassUtils.get_inheriters_from_class(custom_class_modifier.replace("Modifier", "")) 22 | for i in len(classes): 23 | var custom_class = classes[i] 24 | var custom_class_name = custom_class.class.replace("Stat", "") 25 | 26 | add_item(custom_class_name, i) if custom_class.icon == "" else add_icon_item(load(custom_class.icon) as Texture2D, custom_class_name, i) 27 | 28 | items.append(custom_class) 29 | 30 | if stat_modifier.stat_key != null and stat_modifier.stat_key.resource_path == custom_class.path: 31 | select(i) 32 | _on_item_selected(i) 33 | 34 | if selected <= 0: 35 | select(0) 36 | _on_item_selected(0) 37 | 38 | func _on_item_selected(index: int) -> void: 39 | var custom_class: Dictionary = items[index] 40 | stat_modifier.stat_key = load(custom_class.path) 41 | -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/editor/stats/modifiers/stat_modifier_editor.gd: -------------------------------------------------------------------------------- 1 | extends EnhancedEditorInspectorPlugin 2 | 3 | const StatModifierButton = preload("res://addons/enhanced_stat/scenes/editor/stats/modifiers/StatModifierButton.tscn") 4 | 5 | func _can_handle(object: Object) -> bool: 6 | return object is StatModifier 7 | 8 | 9 | func _parse_property(object: Object, type: Variant.Type, name: String, hint_type: PropertyHint, hint_string: String, usage_flags: int, wide: bool) -> bool: 10 | if name == "stat_key": 11 | var button = StatModifierButton.instantiate() 12 | button.initialize(object) 13 | add_custom_editor_inspector_container("Stat", button) 14 | return true 15 | 16 | return false -------------------------------------------------------------------------------- /addons/enhanced_stat/scripts/utils/stat_utils.gd: -------------------------------------------------------------------------------- 1 | extends Object 2 | class_name StatUtils 3 | 4 | 5 | static func bind_stat(target: Object, property: String, stat_key: GDScript, stats_manager: StatsManager) -> void: 6 | if target == null or property == "": 7 | return push_error("Target has not been configured properly.") 8 | 9 | if stat_key == null or stats_manager == null: 10 | return push_error("Stat has not been configured properly.") 11 | 12 | var _stat: Stat = stats_manager.get_stat(stat_key) 13 | var target_value = target.get(property) 14 | 15 | if target_value != null and not target_value is Object: 16 | return push_error("Couldn't bind an object to a primitive type, did you meant to bind the value instead ?") 17 | 18 | if target_value == _stat: 19 | return 20 | 21 | target.set(property, _stat) 22 | 23 | static func unbind_stat(target: Object, property: String) -> void: 24 | target.set(property, null) 25 | 26 | static func bind_stat_value(target: Object, property: String, stat_key: GDScript, stats_manager: StatsManager): 27 | if target == null or property == "": 28 | push_error("Target has not been configured properly.") 29 | return null 30 | 31 | if stat_key == null or stats_manager == null: 32 | push_error("Stat has not been configured properly.") 33 | return null 34 | 35 | var target_value = target.get(property) 36 | if target_value != null and target_value is Object: 37 | push_error("Couldn't bind a primitive type to an object, did you meant to bind the stat instead ?") 38 | return null 39 | 40 | var _stat: Stat = stats_manager.get_stat(stat_key) 41 | assert(_stat != null) 42 | 43 | var _on_value_changed: Callable = \ 44 | func _on_value_changed() -> void: 45 | target.set(property, _stat.value) 46 | 47 | _stat.value_changed.connect(_on_value_changed) 48 | _on_value_changed.call() 49 | return _on_value_changed 50 | 51 | static func unbind_stat_value(target: Object, property: String, _on_value_changed: Callable) -> void: 52 | if _on_value_changed == null: 53 | return 54 | 55 | var _stat: Stat = target.get(property) 56 | 57 | if _stat == null: 58 | return push_warning("Can't unbind null _stat.") 59 | 60 | _stat.value_changed.disconnect(_on_value_changed) 61 | -------------------------------------------------------------------------------- /docs/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/.nojekyll -------------------------------------------------------------------------------- /docs/README.md: -------------------------------------------------------------------------------- 1 | ![logo](assets/logo.png) 2 | 3 | [![Godot Version](https://img.shields.io/badge/Godot-4.1-brightgreen.svg)](https://godotengine.org) 4 | [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) 5 | [![Static Badge](https://img.shields.io/badge/Doc-0.0.1-blue)](https://zennyth.github.io/EnhancedStat/) 6 | 7 | **Enhanced Stat** is an addon suite for Godot 4.1, designed to provide an intuitive and powerful way to manage stats in games such as Health, Mana, Speed, and Attack Damage. This addon is part of the **Enhanced** suite aimed to make your Godot development faster, cleaner, and more enjoyable! 8 | 9 | # 🚀 Features 10 | 11 | ## 📈 Stats 12 | 13 | - **Reactive Programming**: Stats are reactive, and changes can be listened to in real-time. 14 | - **Computed Stats**: Type safe basic stats. 15 | - **Aggregated Stats**: Create new stats based on existing stats, automatically updating when dependencies change. 16 | - **Bind Mechanism**: Allows easy binding of stats to in game nodes. 17 | - **Modifiers**: Flexible modification of stats through addition, multiplication, or other custom methods. 18 | - **Listeners**: Events to notify game logic of stats changes. 19 | 20 | ## ⚡ Status Effects 21 | 22 | - **Component-based**: Reusable components that can be combined to create complex status effects. 23 | - **Modifiers**: Attachable to stats to create temporary or permanent changes. 24 | - **Vfx**: Add vfxs or nodes while the status effect is active. 25 | 26 | ### 💻 Editor Friendly 27 | 28 | - **Editor Inspector**: Use the editor to configure the stats you need for your game, the status effects and more ... 29 | 30 | 31 | # 📦 Installation 32 | 33 | 1. Clone or download the repository. 34 | 2. Copy the `enhanced_stat` and `enhanced_common` folders inside your project's `addons` directory. 35 | 3. Enable the addon by going to `Project -> Project Settings -> Plugins` and activating the "Enhanced Stat" and "Enhanced Common" plugin. 36 | 37 | # 🍻 Contribute 38 | 39 | Do you want to contribute? Learn more in [the contribution section](/contribute.md). 40 | 41 | # 🥰 Credits 42 | 43 | -------------------------------------------------------------------------------- /docs/_sidebar.md: -------------------------------------------------------------------------------- 1 | * [⚡ Getting started](/) 2 | * [📗 Manual](/manual/main.md) 3 | * [Managing Stats](/manual/stats/main.md) 4 | * [Creating Stats](/manual/stats/create.md) 5 | * [Computed Stats](/manual/stats/computed.md) 6 | * [Aggregated Stats](/manual/stats/aggregated.md) 7 | * [Binding Stats](/manual/stats/bind.md) 8 | * [Stat Modifiers](/manual/stats/modifiers.md) 9 | * [Status Effects](/manual/status_effects/main.md) 10 | * [🍻 Contribute](/contribute.md) 11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /docs/assets/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/logo.png -------------------------------------------------------------------------------- /docs/assets/stat_binding_configuration.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/stat_binding_configuration.png -------------------------------------------------------------------------------- /docs/assets/stat_binding_dropdown.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/stat_binding_dropdown.png -------------------------------------------------------------------------------- /docs/assets/stats_manager.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/stats_manager.png -------------------------------------------------------------------------------- /docs/assets/status_effect_applier.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/status_effect_applier.png -------------------------------------------------------------------------------- /docs/assets/stun.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/stun.png -------------------------------------------------------------------------------- /docs/assets/stun_files.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/assets/stun_files.png -------------------------------------------------------------------------------- /docs/contribute.md: -------------------------------------------------------------------------------- 1 | # 🍻 Contributing to this project 2 | 3 | If you'd like to suggest improvements to this add-on or fix issues, you can raise a pull request or [raise an issue](https://github.com/zennyth/enhanced_stat/issues). 4 | 5 | ## 🧪 Unit testing 6 | 7 | This project will use [gdUnit](https://github.com/MikeSchulze/gdUnit4) to ensure code quality. Every pull request that introduces new changes, such as nodes or additional methods, must also provide some unit tests inside the `test/` folder. Make sure your test is in the correct folder. 8 | 9 | ## ⚡ Adding a new node 10 | 11 | If you want to introduce a new node, raise a pull request after checking the issues tab for any discussions on new nodes. It's a great place to gather feedback before implementing a new node. Ensure that you also introduce an icon for your node that follows the color scheme: 12 | 13 | - Control: `#A5EFAC` 14 | - Node2D: `#A3B4F0` 15 | - Utility Node and Resource: `#E0E0E0` 16 | 17 | Also, update the `README.md` file with the documentation for the newly introduced node. 18 | 19 | ## 📚 Adding documentation 20 | 21 | If you're introducing a new feature or changing behavior, update the wiki accordingly. Modify the `/docs` folder inside the repository. To test your wiki locally, run the following command: 22 | ```bash 23 | docsify serve ./docs 24 | ``` 25 | > 💡 [Learn more](https://docsify.js.org/#/?id=docsify) about how to use **docsify**. -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Document 6 | 7 | 8 | 9 | 10 | 11 | 12 |
13 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /docs/manual/main.md: -------------------------------------------------------------------------------- 1 | # :book: Enhanced Stat Manual 2 | 3 | Welcome to the Enhanced Stat Manual! This manual will guide you through how to get the most out of the Enhanced Stat addon for Godot 4.1. Whether you are new to game development or a seasoned pro, this manual aims to provide you with a thorough understanding of how to efficiently manage stats and status effects in your game. 4 | 5 | --- 6 | 7 | ## :wave: Introduction 8 | 9 | The Enhanced Stat addon is a comprehensive tool to manage game stats like Health, Mana, Speed, Attack Damage, etc., along with status effects such as buffs and debuffs. It uses the principles of reactive programming to ensure your stats are always up-to-date and easily manageable. 10 | 11 | --- 12 | 13 | ## :rocket: Getting Started 14 | 15 | First, make sure you've followed the [Installation](/README.md#installation) instructions from the README file. 16 | 17 | - Ensure that the addon is activated in your Godot project. 18 | - Make sure the `enhanced_common` dependency is also activated. 19 | 20 | --- 21 | 22 | ## Resource Management 23 | All resources whether they are `Stat`, `Stats` or `StatusEffect` are templates. It means, they will be duplicated at runtime by their `StatsManager` or `StatusEffectManager`, it ensures the uniqueness of each stat for each instance of scenes. 24 | > For example, you don't want all of your enemies to share the same health bar ! 25 | 26 | --- 27 | 28 | We hope this manual helps you to effectively use the Enhanced Stat addon to enrich your game development experience. Happy coding! :smile: -------------------------------------------------------------------------------- /docs/manual/stats/aggregated.md: -------------------------------------------------------------------------------- 1 | ## Aggregated Stats: The Composite Architecture :chart_with_upwards_trend: 2 | 3 | Aggregated stats are a powerful feature in Enhanced Stat, allowing you to create complex stat structures from simpler computed stats. These stats manage multiple `ComputedStat` instances, distributing modifiers and calculations across them. In this section, we'll focus on `PoolStat` and `GrowableStat`, which are two core types of aggregated stats. 4 | 5 | Both have their implemented version of `Int` and `Float` class. 6 | 7 | --- 8 | 9 | ### PoolStat: Min, Max, and Is_Infinite :swimming_woman: 10 | 11 | The `PoolStat` class is made up of three main computed stats: 12 | 13 | - **Min**: The minimum `NumberStat` that the value can have. 14 | - **Max**: The maximum `NumberStat` that the value can reach. 15 | - **Is_Infinite**: A `BoolStat` indicating whether the value can change. 16 | 17 | #### How to Use PoolStat: 18 | 19 | ```gdscript 20 | @icon("res://examples/icons/icons8-heart-24.png") 21 | extends IntPoolStat 22 | class_name HealthStat 23 | ``` 24 | 25 | #### Interface: 26 | 27 | The `PoolStat` class has an interface that allows you to modify each of its constituent computed stats individually. 28 | 29 | - Signals: `depleted`, `replenished`, `increased(value, amount)`, `decreased(value, amount)` 30 | - Methods: `deplete()`, `replenish()`, `increase(amount)`, `decrease(amount)` 31 | 32 | ### GrowableStat: Leveling Up :arrow_up: 33 | 34 | The `GrowableStat` class is based on `PoolStat` but provides additional functionality for growing a stat when its value reaches the max value. This is especially useful for stats like XP or Mana that may need to be expanded over time. 35 | 36 | #### How to Use GrowableStat: 37 | 38 | ```gdscript 39 | extends IntGrowableStat 40 | class_name LevelStat 41 | ``` 42 | 43 | #### Interface: 44 | 45 | The `GrowableStat` class provides additional methods to handle growth. 46 | 47 | - `grow()`: Increases the `max_value` and resets the current value. 48 | 49 | ### AggregatedStat and StatModifiers :wrench: 50 | 51 | The `AggregatedStat` class is designed to handle `StatModifiers` elegantly by distributing them to the right computed stats. 52 | 53 | For example, if you have a `StatModifier` that is meant to increase the Max Health of an entity, `AggregatedStat` will automatically route that modifier to the `max` computed stat of a `PoolStat`. 54 | 55 | --- 56 | 57 | By combining computed stats into aggregated stats like `PoolStat` and `GrowableStat`, you can manage intricate gameplay mechanics and systems with ease. These classes provide a flexible and robust framework for all kinds of stat-based game features. :game_die: -------------------------------------------------------------------------------- /docs/manual/stats/bind.md: -------------------------------------------------------------------------------- 1 | ## Stat Binding: Dynamic Synchronization :link: 2 | 3 | Stat binding allows for a seamless integration between your game logic and stats. The addon provides two types of stat binding nodes, `StatBind` and `StatValueBind`, that can be used to dynamically update the properties of other nodes based on your stats. 4 | 5 | Both nodes share the same core functionality but differ in what they bind: 6 | 7 | - **StatBind**: Binds the entire `Stat` object to a property. 8 | - **StatValueBind**: Binds just the value of a `Stat` to a property. 9 | 10 | --- 11 | 12 | ### Configuring the StatBind :gear: 13 | 14 | Before you can use either `StatBind` or `StatValueBind`, you need to configure the `StatBind` properly. 15 | 16 | 1. **Assign the StatsManager**: Link the `StatsManager` responsible for managing the stats you want to bind. 17 | 2. **Set the Target Node**: Identify which node's property will be bound to the stat. 18 | 3. **Set the Property to be Bound**: Specify which property of the target node you wish to bind to the stat. 19 | 20 | ![logo](../../assets/stat_binding_configuration.png) 21 | 22 | ### Stat Selection Dropdown :arrow_down_small: 23 | 24 | After you've configured the `StatBind`, a dropdown menu will appear in the inspector, showing you all the stats that can be bound. Simply select the stat you wish to bind from this dropdown. 25 | 26 | ![logo](../../assets/stat_binding_dropdown.png) 27 | 28 | --- 29 | 30 | By making use of `StatBind` and `StatValueBind`, you can automate the updating of game elements based on stat changes, creating a more dynamic and reactive gameplay experience. :rocket: -------------------------------------------------------------------------------- /docs/manual/stats/computed.md: -------------------------------------------------------------------------------- 1 | ## Computed Stats: The Building Blocks :building_construction: 2 | 3 | Computed stats serve as the foundation for more complex stats in your game. These are base stats that define basic types like integers (`IntStat`), floating-point numbers (`FloatStat`), and boolean (`BoolStat`). Unlike other stat types, computed stats have a unique interface that allows them to be modified using `StatModifier`. 4 | 5 | ### Types of Computed Stats :abacus: 6 | 7 | - **Int**: Used for whole numbers, like coins. 8 | 9 | ```gdscript 10 | extends IntStat 11 | class_name CoinStat 12 | ``` 13 | 14 | - **Float**: Utilized for fractions and real numbers, ideal for stats like Speed or Attack Speed. 15 | 16 | ```gdscript 17 | @icon("res://examples/icons/icons8-speed-24.png") 18 | extends FloatStat 19 | class_name SpeedStat 20 | ``` 21 | 22 | - **Bool**: Used for binary stats that can be either True or False, like a 'Controllable' status. 23 | 24 | ```gdscript 25 | @icon("res://examples/icons/icons8-puppet-24.png") 26 | extends BoolStat 27 | class_name ControllableStat 28 | ``` -------------------------------------------------------------------------------- /docs/manual/stats/create.md: -------------------------------------------------------------------------------- 1 | ## Creating a Custom Stat :bulb: 2 | 3 | Creating a custom stat is a straightforward process, allowing you to extend the functionality of the existing `Stat` class to suit your specific requirements. Below, we'll walk you through how to create your own stat class. 4 | 5 | ### Step 1: Inherit from the Existing `Stat` Class :bookmark: 6 | 7 | To start, you'll want to inherit from a class that derives from the base `Stat` class provided by the Enhanced Stat addon. 8 | Create a new GDScript file for your custom stat. Make you sure you name your class via the **class_name** key word. 9 | You will find a list of the classes you can inherit from in [Aggregated Stats](/manual/stats/aggragated.md), [Computed Stats](/manual/stats/computed.md). 10 | 11 | ```gdscript 12 | @icon("res://examples/icons/icons8-speed-24.png") 13 | extends FloatStat 14 | class_name SpeedStat 15 | ``` 16 | 17 | In the above example, I've crafted a simple FloatStat to store a numerical value representing the speed of my units. This stat is editable both in the editor and at runtime, providing flexibility for game development. To make it easily identifiable in the editor, I've also assigned it a unique icon. 18 | 19 | ### Step 2: Add the custom stat in a `Stats` container 20 | 21 | ```gdscript 22 | @icon("res://examples/icons/icons8-running-24.png") 23 | extends Stats 24 | class_name CharacterStats 25 | 26 | @export var speed: SpeedStat 27 | ``` 28 | 29 | I've established a resource container for my custom stat, which will act as a blueprint for all my units. This resource will be cloned at runtime for each individual unit instance. To enhance its visibility and quick identification within the editor, I've also associated it with a unique icon. 30 | 31 | ### Step 3: Add a `StatsManager` for the custom container 32 | 33 | ```gdscript 34 | @tool 35 | extends StatsManager 36 | class_name CharacterStatsManager 37 | 38 | 39 | func _ready() -> void: 40 | if Engine.is_editor_hint(): 41 | return 42 | 43 | super() 44 | 45 | func _get_property_list() -> Array: 46 | var result: Array = [] 47 | 48 | result.append({ "name": "stats", "class_name": &"Resource", "type": 24, "hint": 17, "hint_string": "CharacterStats", "usage": 4102 }) 49 | 50 | return result 51 | ``` 52 | 53 | Note that I'm using the "hint_string" property with the same **class_name** (CharacterStats) for the editor to recognize that I only want the `CharacterStatsManager` to display. 54 | 55 | ### Step 4: Create the `CharacterStatsManager` node in your units 56 | 57 | ![logo](../../assets/stats_manager.png) 58 | 59 | You just need to configure it properly based on what you added earlier in your custom `Stats` class. All the code above is shared in the ***examples*** folder at the root of this project. -------------------------------------------------------------------------------- /docs/manual/stats/main.md: -------------------------------------------------------------------------------- 1 | # Managing Stats 2 | 3 | Managing stats effectively is crucial in game development, and Enhanced Stat provides several classes to help you with this. Below is an in-depth guide to manage stats through the classes provided: Stat, Stats, and StatsManager. 4 | 5 | --- 6 | 7 | ## Classes 8 | These classes work in conjunction to provide a comprehensive way to manage game stats and are designed to make it as flexible and robust as possible. Feel free to dig into each class and explore their methods and properties to best fit your game's needs! 9 | 10 | --- 11 | 12 | ### :bookmark: Stat (Extends Resource) 13 | The Stat class is used for representing individual stats, like Health, Mana, Speed, etc. As it inherits from Godot's Resource, it is easily serializable and can be shared among multiple instances or saved for later. 14 | 15 | ### :bookmark_tabs: Stats (Extends Resource) 16 | The Stats class is essentially a container for Stat objects. It is useful when you have an entity that has multiple stats, like a character in an RPG who has health, mana, strength, etc. 17 | 18 | ### :gear: StatsManager (Extends Node) 19 | The StatsManager class provides an interface to manage Stats and is typically attached to the entity that owns those stats. This makes it easier to access and manipulate stats during gameplay. -------------------------------------------------------------------------------- /docs/manual/stats/modifiers.md: -------------------------------------------------------------------------------- 1 | ## Basic Interface :gear: 2 | 3 | The computed stats come with a set of functions to make it easy to compute their values, particularly when using `StatModifier`. 4 | 5 | ### Methods: 6 | 7 | - `compute()`: Calculates the current value of the stat based on all the attached modifiers. 8 | 9 | ```gdscript 10 | health.compute() 11 | ``` 12 | 13 | - `add_stat_modifier(stat_modifier: StatModifier) -> void`: Adds a modifier to the stat. 14 | 15 | ```gdscript 16 | health.add_stat_modifier(health_modifier) 17 | ``` 18 | 19 | - `remove_stat_modifier(stat_modifier: StatModifier) -> void`: Removes a specific modifier from the stat. 20 | 21 | ```gdscript 22 | health.remove_stat_modifier(health_modifier) 23 | ``` 24 | 25 | ### Working with StatModifier :wrench: 26 | 27 | The `StatModifier` is a class used to modify a computed stat. It contains a method that takes the stat's current value and returns a new value. 28 | 29 | For example, a `StatModifier` for an `Int` stat might look like: 30 | 31 | > PS. EnhancedStat has already implemented the basic modifier for you. 32 | 33 | ```gdscript 34 | extends NumberStatModifier 35 | class_name IntStatModifier 36 | 37 | @export var operation_value: int = 0 38 | 39 | func get_operation_value() -> int: 40 | return operation_value 41 | 42 | func apply(value: int, stat: IntStat): 43 | return super(value, stat) 44 | ``` 45 | 46 | To use this `StatModifier` with a computed stat: 47 | 48 | ```gdscript 49 | var add_health_modifier = IntStatModifier.new() 50 | health.add_stat_modifier(add_health_modifier) # health is a Computed stats 51 | ``` 52 | 53 | Now, whenever you call `compute()` on `health`, it will add 10 to its value. Note that whenever you add or remove a modifier to a stat, compute will automatically be called to update the stat. 54 | 55 | ```gdscript 56 | health.compute() # if initial value was 100, it becomes 110 57 | ``` 58 | 59 | --- 60 | 61 | By understanding computed stats and their interfaces, you can create powerful, dynamic stats that change in real-time based on game events, user inputs, or any other criteria you set. This makes your game more engaging and allows for intricate gameplay mechanics. :video_game: 62 | -------------------------------------------------------------------------------- /docs/manual/status_effects/components.md: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/docs/manual/status_effects/components.md -------------------------------------------------------------------------------- /docs/manual/status_effects/main.md: -------------------------------------------------------------------------------- 1 | ## Status Effects: Amplify Gameplay Dynamics :zap: 2 | 3 | Status effects are temporary or long-lasting conditions that can alter game variables, player or enemy behavior, and more. With Enhanced Stat, implementing status effects becomes a highly manageable task. Our addon is designed to follow a component-based approach, making it incredibly versatile and reusable across your project. 4 | 5 | --- 6 | 7 | ### Core Concepts :book: 8 | 9 | - **Status Effect**: The fundamental class representing a status effect. It contains multiple components that define its behavior. 10 | 11 | - **Component**: Each individual functionality of a status effect is encapsulated in a component. For example, a 'Poison' status effect could have damage-over-time and slow-motion components. 12 | 13 | --- 14 | 15 | ### Creating a Status Effect :hammer_and_wrench: 16 | 17 | To create a new status effect, you must create a new resource named after your status effect and inherit `StatusEffect`. 18 | 19 | ![logo](../../assets/stun_files.png) 20 | 21 | > I created the **stun.tres** and **StunVfx.tscn** as a PackedScene for vfxs of the status effect. 22 | 23 | ### Configuring a Status Effect :hammer_and_wrench: 24 | 25 | ![logo](../../assets/stun.png) 26 | 27 | > I've configured the `StatModifierStatusEffectComponent` with a `BoolStatModifier` inside to make the **IsControllable** stat to false once the stun effect kicks in. I've also configured a `VfxStatusEffectComponent` that instantiates a packed scene while the status effect is active. 28 | 29 | ### Applying and Managing Status Effects :control_knobs: 30 | 31 | You can apply a status effect to an entity (which should have a `StatsManager` and a `StatusEffectManager`) using `StatusEffectApplier`: 32 | 33 | ![logo](../../assets/status_effect_applier.png) 34 | 35 | Reference it and call the following method : **status_effect_applier.apply(target: Node)** 36 | ```gdscript 37 | extends EnhancedArea2D 38 | @onready var status_effect_applier: StatusEffectApplier = $StatusEffectApplier 39 | 40 | func _ready() -> void: 41 | node_entered.connect(_on_node_entered) 42 | 43 | func _on_node_entered(node: Node2D) -> void: 44 | status_effect_applier.apply(node) 45 | ``` 46 | 47 | ### Reactive Gameplay :cyclone: 48 | 49 | One of the powerful features of the Enhanced Stat addon is the reactivity of status effects. The `StatusEffect` class is designed to react automatically to changes in stats. For example, a 'Shield' status effect could automatically deactivate itself when the 'ShieldPower' stat reaches zero. 50 | 51 | --- 52 | 53 | By integrating status effects into your game, you can add layers of complexity, making your game more engaging and interactive. Whether it's a short burst of speed, a complex poisoning effect, or a shield that reacts to in-game events, status effects are your go-to tool for dynamic gameplay. :star2: -------------------------------------------------------------------------------- /examples/Main.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=3 format=3 uid="uid://bdgiu5l2kqbpg"] 2 | 3 | [ext_resource type="PackedScene" uid="uid://ck684akobfi16" path="res://examples/MainCharacter.tscn" id="1_jswyl"] 4 | [ext_resource type="PackedScene" uid="uid://vlhkksrpxdkm" path="res://examples/Trap.tscn" id="2_uqf8t"] 5 | 6 | [node name="Main" type="Node2D"] 7 | 8 | [node name="MainCharacter" parent="." instance=ExtResource("1_jswyl")] 9 | 10 | [node name="Trap" parent="." instance=ExtResource("2_uqf8t")] 11 | position = Vector2(136, 0) 12 | -------------------------------------------------------------------------------- /examples/MainCharacter.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=12 format=3 uid="uid://ck684akobfi16"] 2 | 3 | [ext_resource type="Script" path="res://examples/main_character.gd" id="1_cd7i7"] 4 | [ext_resource type="Script" path="res://examples/stats/character_stats_manager.gd" id="1_ol300"] 5 | [ext_resource type="Resource" uid="uid://oe84vs447ksg" path="res://examples/stats/main_character_stats.tres" id="2_5fqki"] 6 | [ext_resource type="Script" path="res://addons/enhanced_common/scripts/controllers_2d/player_controller_2d.gd" id="3_aqdci"] 7 | [ext_resource type="Texture2D" uid="uid://8pvahvtehjux" path="res://docs/assets/logo.png" id="3_kdufo"] 8 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/status_effects/status_effect_manager.gd" id="5_i7qdj"] 9 | [ext_resource type="Script" path="res://addons/enhanced_common/scripts/motion_2d/character_body_motion_2d.gd" id="6_jnuk4"] 10 | [ext_resource type="Script" path="res://examples/stats/controllable_stat.gd" id="8_5b5gp"] 11 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/stats/bind/stat_bind.gd" id="8_7ci34"] 12 | [ext_resource type="Script" path="res://examples/stats/speed_stat.gd" id="9_v7rh6"] 13 | 14 | [sub_resource type="RectangleShape2D" id="RectangleShape2D_6m5hq"] 15 | size = Vector2(22, 32) 16 | 17 | [node name="MainCharacter" type="CharacterBody2D"] 18 | collision_mask = 0 19 | script = ExtResource("1_cd7i7") 20 | 21 | [node name="Camera2D" type="Camera2D" parent="."] 22 | position_smoothing_enabled = true 23 | position_smoothing_speed = 10.0 24 | 25 | [node name="Sprite2D" type="Sprite2D" parent="."] 26 | scale = Vector2(0.05, 0.05) 27 | texture = ExtResource("3_kdufo") 28 | 29 | [node name="CollisionShape2D" type="CollisionShape2D" parent="."] 30 | visible = false 31 | position = Vector2(1, -1) 32 | shape = SubResource("RectangleShape2D_6m5hq") 33 | 34 | [node name="Stats" type="Node" parent="."] 35 | script = ExtResource("1_ol300") 36 | stats = ExtResource("2_5fqki") 37 | 38 | [node name="StatusEffects" type="Node" parent="."] 39 | script = ExtResource("5_i7qdj") 40 | 41 | [node name="Controller2D" type="Node2D" parent="."] 42 | script = ExtResource("3_aqdci") 43 | 44 | [node name="StatBind" type="Node" parent="Controller2D" node_paths=PackedStringArray("stats_manager", "target")] 45 | script = ExtResource("8_7ci34") 46 | stats_manager = NodePath("../../Stats") 47 | mode = 1 48 | target = NodePath("..") 49 | stat_key = ExtResource("8_5b5gp") 50 | property_to_bind = "is_controllable" 51 | 52 | [node name="Motion2D" type="Node" parent="." node_paths=PackedStringArray("target")] 53 | script = ExtResource("6_jnuk4") 54 | target = NodePath("..") 55 | autostart = true 56 | 57 | [node name="StatBind" type="Node" parent="Motion2D" node_paths=PackedStringArray("stats_manager", "target")] 58 | script = ExtResource("8_7ci34") 59 | stats_manager = NodePath("../../Stats") 60 | mode = 1 61 | target = NodePath("..") 62 | stat_key = ExtResource("9_v7rh6") 63 | property_to_bind = "speed" 64 | -------------------------------------------------------------------------------- /examples/StunVfx.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=5 format=3 uid="uid://djm60vxv46gse"] 2 | 3 | [ext_resource type="Texture2D" uid="uid://c1ey2m3tsixru" path="res://examples/icons/icons8-heart-24.png" id="1_a7ido"] 4 | 5 | [sub_resource type="Gradient" id="Gradient_phvvg"] 6 | colors = PackedColorArray(1, 1, 1, 1, 1, 1, 1, 0) 7 | 8 | [sub_resource type="GradientTexture1D" id="GradientTexture1D_q2i5b"] 9 | gradient = SubResource("Gradient_phvvg") 10 | 11 | [sub_resource type="ParticleProcessMaterial" id="ParticleProcessMaterial_t2ngq"] 12 | emission_shape = 1 13 | emission_sphere_radius = 2.0 14 | particle_flag_disable_z = true 15 | gravity = Vector3(0, -98, 0) 16 | angular_velocity_max = 50.0 17 | orbit_velocity_min = 0.0 18 | orbit_velocity_max = 0.0 19 | angle_max = 50.0 20 | scale_min = 0.2 21 | scale_max = 0.4 22 | color = Color(0.905882, 0, 0, 1) 23 | color_ramp = SubResource("GradientTexture1D_q2i5b") 24 | 25 | [node name="StunVfx" type="GPUParticles2D"] 26 | process_material = SubResource("ParticleProcessMaterial_t2ngq") 27 | texture = ExtResource("1_a7ido") 28 | -------------------------------------------------------------------------------- /examples/Trap.tscn: -------------------------------------------------------------------------------- 1 | [gd_scene load_steps=6 format=3 uid="uid://vlhkksrpxdkm"] 2 | 3 | [ext_resource type="Script" path="res://examples/trap.gd" id="1_0wlgu"] 4 | [ext_resource type="Texture2D" uid="uid://c1ey2m3tsixru" path="res://examples/icons/icons8-heart-24.png" id="2_nc2di"] 5 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/status_effects/status_effect_applier.gd" id="3_g3xux"] 6 | [ext_resource type="Resource" uid="uid://bjlna64ih6rym" path="res://examples/stun.tres" id="4_swh51"] 7 | 8 | [sub_resource type="CircleShape2D" id="CircleShape2D_b01lp"] 9 | radius = 62.0 10 | 11 | [node name="Trap" type="Area2D"] 12 | collision_layer = 0 13 | script = ExtResource("1_0wlgu") 14 | 15 | [node name="CollisionShape2D" type="CollisionShape2D" parent="."] 16 | shape = SubResource("CircleShape2D_b01lp") 17 | 18 | [node name="Sprite2D" type="Sprite2D" parent="."] 19 | texture = ExtResource("2_nc2di") 20 | 21 | [node name="StatusEffectApplier" type="Node" parent="."] 22 | script = ExtResource("3_g3xux") 23 | status_effects = Array[Resource("res://addons/enhanced_stat/scripts/core/status_effects/status_effect.gd")]([ExtResource("4_swh51")]) 24 | -------------------------------------------------------------------------------- /examples/icons/icons8-heart-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/examples/icons/icons8-heart-24.png -------------------------------------------------------------------------------- /examples/icons/icons8-puppet-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/examples/icons/icons8-puppet-24.png -------------------------------------------------------------------------------- /examples/icons/icons8-running-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/examples/icons/icons8-running-24.png -------------------------------------------------------------------------------- /examples/icons/icons8-speed-24.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Zennyth/EnhancedStat/98bee9ca094c625defa5543cfa17a1e88c42fdb7/examples/icons/icons8-speed-24.png -------------------------------------------------------------------------------- /examples/main_character.gd: -------------------------------------------------------------------------------- 1 | extends CharacterBody2D 2 | 3 | @onready var _controller: Controller2D = $Controller2D 4 | @onready var _motion: Motion2D = $Motion2D 5 | 6 | 7 | func _ready() -> void: 8 | _controller.move_direction_changed.connect(_on_move_direction_changed) 9 | 10 | func _on_move_direction_changed(direction: Vector2) -> void: 11 | _motion.direction = direction -------------------------------------------------------------------------------- /examples/stats/character_stats.gd: -------------------------------------------------------------------------------- 1 | @icon("res://examples/icons/icons8-running-24.png") 2 | extends Stats 3 | class_name CharacterStats 4 | 5 | @export var controllable: ControllableStat 6 | @export var health: HealthStat 7 | @export var speed: SpeedStat -------------------------------------------------------------------------------- /examples/stats/character_stats_manager.gd: -------------------------------------------------------------------------------- 1 | @tool 2 | extends StatsManager 3 | class_name CharacterStatsManager 4 | 5 | 6 | func _ready() -> void: 7 | if Engine.is_editor_hint(): 8 | return 9 | 10 | super() 11 | 12 | func _get_property_list() -> Array: 13 | var result: Array = [] 14 | 15 | result.append({ "name": "stats", "class_name": &"Resource", "type": 24, "hint": 17, "hint_string": "CharacterStats", "usage": 4102 }) 16 | 17 | return result -------------------------------------------------------------------------------- /examples/stats/controllable_stat.gd: -------------------------------------------------------------------------------- 1 | @icon("res://examples/icons/icons8-puppet-24.png") 2 | extends BoolStat 3 | class_name ControllableStat -------------------------------------------------------------------------------- /examples/stats/health_stat.gd: -------------------------------------------------------------------------------- 1 | @icon("res://examples/icons/icons8-heart-24.png") 2 | extends IntPoolStat 3 | class_name HealthStat -------------------------------------------------------------------------------- /examples/stats/main_character_stats.tres: -------------------------------------------------------------------------------- 1 | [gd_resource type="Resource" script_class="CharacterStats" load_steps=11 format=3 uid="uid://oe84vs447ksg"] 2 | 3 | [ext_resource type="Script" path="res://examples/stats/character_stats.gd" id="1_lwvtb"] 4 | [ext_resource type="Script" path="res://examples/stats/controllable_stat.gd" id="1_wpt1d"] 5 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/stats/stat/computed/number/int_stat.gd" id="2_xfufk"] 6 | [ext_resource type="Script" path="res://examples/stats/health_stat.gd" id="3_tlg4f"] 7 | [ext_resource type="Script" path="res://examples/stats/speed_stat.gd" id="5_ujxmp"] 8 | 9 | [sub_resource type="Resource" id="Resource_wpc8h"] 10 | script = ExtResource("1_wpt1d") 11 | default_value = true 12 | 13 | [sub_resource type="Resource" id="Resource_8epgt"] 14 | script = ExtResource("2_xfufk") 15 | default_value = 10 16 | 17 | [sub_resource type="Resource" id="Resource_d3vnn"] 18 | script = ExtResource("2_xfufk") 19 | default_value = 0 20 | 21 | [sub_resource type="Resource" id="Resource_e7edq"] 22 | script = ExtResource("3_tlg4f") 23 | max = SubResource("Resource_8epgt") 24 | min = SubResource("Resource_d3vnn") 25 | default_value = -1 26 | 27 | [sub_resource type="Resource" id="Resource_jbcoo"] 28 | script = ExtResource("5_ujxmp") 29 | default_value = 100.0 30 | 31 | [resource] 32 | script = ExtResource("1_lwvtb") 33 | controllable = SubResource("Resource_wpc8h") 34 | health = SubResource("Resource_e7edq") 35 | speed = SubResource("Resource_jbcoo") 36 | -------------------------------------------------------------------------------- /examples/stats/speed_stat.gd: -------------------------------------------------------------------------------- 1 | @icon("res://examples/icons/icons8-speed-24.png") 2 | extends FloatStat 3 | class_name SpeedStat -------------------------------------------------------------------------------- /examples/stun.tres: -------------------------------------------------------------------------------- 1 | [gd_resource type="Resource" script_class="StatusEffect" load_steps=10 format=3 uid="uid://bjlna64ih6rym"] 2 | 3 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/status_effects/status_effect.gd" id="1_ecr30"] 4 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/status_effects/components/stat_modifier_status_effect_component.gd" id="2_54da5"] 5 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/stats/modifiers/computed/bool_stat_modifier.gd" id="3_4xyp4"] 6 | [ext_resource type="Script" path="res://examples/stats/controllable_stat.gd" id="4_eod4l"] 7 | [ext_resource type="PackedScene" uid="uid://djm60vxv46gse" path="res://examples/StunVfx.tscn" id="4_h3i7d"] 8 | [ext_resource type="Script" path="res://addons/enhanced_stat/scripts/core/status_effects/components/vfx_status_effect_component.gd" id="4_omh0b"] 9 | 10 | [sub_resource type="Resource" id="Resource_gfebl"] 11 | script = ExtResource("3_4xyp4") 12 | new_value = false 13 | stat_key = ExtResource("4_eod4l") 14 | apply_count = 1 15 | 16 | [sub_resource type="Resource" id="Resource_r3j7t"] 17 | script = ExtResource("2_54da5") 18 | stat_modifiers = Array[Resource("res://addons/enhanced_stat/scripts/core/stats/modifiers/stat_modifier.gd")]([SubResource("Resource_gfebl")]) 19 | 20 | [sub_resource type="Resource" id="Resource_vnhlj"] 21 | script = ExtResource("4_omh0b") 22 | packed_vfx = ExtResource("4_h3i7d") 23 | 24 | [resource] 25 | script = ExtResource("1_ecr30") 26 | id = "Stun" 27 | duration = 1.0 28 | tick_interval = 0.0 29 | status_effect_components = Array[Resource("res://addons/enhanced_stat/scripts/core/status_effects/components/_status_effect_component.gd")]([SubResource("Resource_r3j7t"), SubResource("Resource_vnhlj")]) 30 | -------------------------------------------------------------------------------- /examples/trap.gd: -------------------------------------------------------------------------------- 1 | extends EnhancedArea2D 2 | 3 | @onready var status_effect_applier: StatusEffectApplier = $StatusEffectApplier 4 | 5 | func _ready() -> void: 6 | node_entered.connect(_on_node_entered) 7 | 8 | func _on_node_entered(node: Node2D) -> void: 9 | status_effect_applier.apply(node) -------------------------------------------------------------------------------- /project.godot: -------------------------------------------------------------------------------- 1 | ; Engine configuration file. 2 | ; It's best edited using the editor UI and not directly, 3 | ; since the parameters that go here are not all obvious. 4 | ; 5 | ; Format: 6 | ; [section] ; section goes between [] 7 | ; param=value ; assign values to parameters 8 | 9 | config_version=5 10 | 11 | [application] 12 | 13 | config/name="Enhanced Stat" 14 | config/tags=PackedStringArray("addon") 15 | run/main_scene="res://examples/Main.tscn" 16 | config/features=PackedStringArray("4.2", "Forward Plus") 17 | config/icon="res://docs/assets/logo.png" 18 | 19 | [autoload] 20 | 21 | ClassUtils="*res://addons/enhanced_common/scripts/utils/class_utils.gd" 22 | NodeBinder="*res://addons/enhanced_common/scripts/node_binders/node_binder.gd" 23 | 24 | [editor_plugins] 25 | 26 | enabled=PackedStringArray("res://addons/enhanced_common/plugin.cfg", "res://addons/enhanced_stat/plugin.cfg") 27 | 28 | [input] 29 | 30 | ctrl_right={ 31 | "deadzone": 0.5, 32 | "events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194321,"key_label":0,"unicode":0,"echo":false,"script":null) 33 | , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":68,"key_label":0,"unicode":100,"echo":false,"script":null) 34 | ] 35 | } 36 | ctrl_left={ 37 | "deadzone": 0.5, 38 | "events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194319,"key_label":0,"unicode":0,"echo":false,"script":null) 39 | , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":65,"key_label":0,"unicode":113,"echo":false,"script":null) 40 | ] 41 | } 42 | ctrl_down={ 43 | "deadzone": 0.5, 44 | "events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194322,"key_label":0,"unicode":0,"echo":false,"script":null) 45 | , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":83,"key_label":0,"unicode":115,"echo":false,"script":null) 46 | ] 47 | } 48 | ctrl_up={ 49 | "deadzone": 0.5, 50 | "events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194320,"key_label":0,"unicode":0,"echo":false,"script":null) 51 | , Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":87,"key_label":0,"unicode":122,"echo":false,"script":null) 52 | ] 53 | } 54 | --------------------------------------------------------------------------------