Relintai/entity_spell_system
1
0
Fork 0
mirror of https://github.com/Relintai/entity_spell_system.git synced 2025-04-19 21:33:15 +02:00
Code Issues Packages Projects Releases Wiki Activity

Quick and dirty Readme.md. I will clean it up later.

Browse Source
This commit is contained in:
Relintai 2019-11-22 00:55:01 +01:00
parent f87a7a8cb2
commit 9e16f68ff7
1 changed files with 38 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md Normal file
View File

@ -0,0 +1,38 @@
# Entity Spell System
An entity and spell system for the GODOT Engine.
Be warned! API breakages still happen a lot, only use this module, if that's okay with you!
The actual player, mob etc implementations are still in the main game's repository. (As GDScript)
Also there is a data editor addon for this module. The main game should have it.
This module have dependencies to some of my other engine modules, these will be made optional later, for now you will need to install them as well.
The main class that can be used for players/mobs is Entity. I ended up merging subclass functionality into it, because
that way it gains a lot more utility, by sacrificing only a small amount of memory.
For example this way it is easy to make chests attack the player, or make spell that animate objects.
Spell is the class you need to create spells, it stores the data, and also it has the ability to be scripted.
Aura is also built the same way.
The module provides a huge number of script callbacks, usually as vmethods.
The main data class is EntityData. You will need this to properly initialize an entity.
The module can do multiplayer, but it's not finished, and at the moment not safe to use. It should mostly work though.
Also it supports entity visibility. If you need rpcs that use this, use vrpc. (Implemented inside Entity).
Every variable is broken up into clientside, and serverside ones, when applicable. This makes it easy to
develop games, that can also run locally, with less overhead. And simpler logic.
E.g. this makes it easy to use the visibility system even on the server, because you just use the clientside variables,
and the logic will work the same way.
Right now everything wokrs authoritatively, except for movement. FYI Movement is handled in GDScript int the game's repo right now.
(I plan to implement authoritative movement later.)
Everything is called the remotesync way, but instead of remotesync, I have c++ macros, which sends the rpc, and then calls the given function directly aswell.
For usage check the main game's repo.