-
Notifications
You must be signed in to change notification settings - Fork 249
Open
Description
There's a section on the development wiki for writing guidebook entries, however it doesn't mention the addition of space-wizards/space-station-14/pull/27570.
In short, the ProtoTag richtext is a way of linking prototype information that is passed to the component of a system to the guidebook, so it's represented in-game. This makes it really nice and futureproof as someone can change values in the YAML or in component hardcode and it's reflected in the guidebook.
However, this isn't actually documented in the guidebook entries section for the dev wiki.
The basics behind ProtoTag (this is just my experience, not exactly textbook):
- Prototag uses the format
[protodata="<id>" comp="<component>" member="<member>"/]
. Pulling info is pretty simple. For example, if you want to pull info on how much power an RTG draws, you would do[protodata="GeneratorRTG" comp="PowerSupplier" member="MaxSupply"/]
. - You can supply an optional
format="<format>"
to format the data it pulls using float.ToString(). I've found this microsoft doc to be a good resources when using these format strings. - In order for the system to work it needs to collect information on what members to pull from, so you need to append
[GuidebookData]
usingContent.Shared.Guidebook
. These members can't be private. - Whatever
<uid>
you're using can't be an abstract or it throws a fit.
Tayrtahn
Metadata
Metadata
Assignees
Labels
No labels