User:Pinsplash/Entity Overhaul Project
This is a massive project currently underway with multiple goals in mind:
- Ensure that ALL entity keyvalues, inputs, and outputs get documented. To do this, we are searching through datamaps and code, for all the major titles covered on the wiki. We currently only have (to be polished) keyvalue templates for
CBaseEntity
andCBaseAnimating
, but we've already encountered and documented obscure yet useful KV's that have never been individually noted online. (Yes, the entire internet.) - Improve the current templates used by entity articles so that pages display less information that does not apply to them, less clutter. This is a more complex, but easier job. Most of the work for this is summarized here.
- Switch from FGD BaseClasses to the engine's C++ classes as the basis for K/I/O templates. All entity pages will be more comprehensive and accurate in regards to abilities and uses.
We are not focusing on flags as much, because documentation on them is already mostly perfect (it's pretty hard to gloss over them).
Progress
Proof of our work so far.
- User:Pinsplash/Datamaps - A huge list of datamaps, which show us every KV, input, and output for every single entity the engine can access.
- FGD Template Prototype - Explanation on how to apply and make the new templates.
Currently, keyvalue templates are being formed.
- Template:KV BaseEntity
- Template:KV BaseAnimating
- Template:KV CAI BaseNPC
- Template:I BaseEntity
- Template:I BaseAnimating
- Template:I CAI BaseNPC
- Template:O BaseEntity
- Template:O BaseAnimating
- Template:O CAI BaseNPC
Thanks
Without these people, this would not be possible.
- User:Ficool2, first goal, main documentation and research.
- User:Pinsplash, second goal, template coding, datamap retrieval.
- User:TeamSpen210, contributor of the third goal.
- User:Practical Problems, Portal 2 datamap.
- The entire SourceMod developer team, for enabling datamaps to be retrieved in a pinch.
- UVW, our Discord server which has been crucial for communication.
- VSES 2007 leak.