Add technical documentation to the docs folder, including architecture, API references, and guides.#159
Open
GabrielTrigo wants to merge 1 commit intoNotulp:masterfrom
Open
Conversation
…e, API references, and guides. Update API reference and hooks documentation for clarity and accuracy Fix documentation errors and add missing API references (PermissionSystem, Zone3D, Web)
Author
|
@dretax , what do you think about this documentation PR? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces comprehensive API reference documentation for key Fougerite scripting systems. The documentation covers the plugin base class, data persistence, permissions, entity wrappers, and event classes, providing detailed usage examples and property/method reference tables for plugin developers.
The most important changes are:
Plugin Base Class and Utilities
BasePlugin, detailing plugin identity, timers (including parallel timers), file I/O (INI/JSON), logging, cross-plugin calls, thread-safe collections, and global shared data, with Python code examples and notes on path safety.Data Persistence
DataStoresingleton, explaining thread-safe key-value storage, CRUD operations, Unity type serialization, INI conversion, and practical usage patterns (e.g., home system, kill counter, IP blacklist).Permission System
PermissionSystem, including concepts (groups, wildcards), permission checks, group/player management, querying, reload, temporary revocation, and practical command guard examples.Entity and Event Wrappers
Entitywrapper, describing identification, position, ownership, health, inventory, linked structures, and destruction, with practical hook usage examples.HurtEvent,DeathEvent,GatherEvent,DoorEvent,DecayEvent,CraftingEvent,InventoryModEvent,BanEvent,PlayerApprovalEvent,ConsoleEvent,TimedEvent), including their properties, mutability, and usage in hooks.