Files
RobustToolbox/Robust.Shared/Prototypes/Docs.xml
slarticodefast 4747e5a05a Add and update a lot of documentation (#6337)
* Serialization docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* ECS docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* scattered docs

Co-authored-by: Moony <moonheart08@users.noreply.github.com>

* Fixes

---------

Co-authored-by: Moony <moonheart08@users.noreply.github.com>
Co-authored-by: PJB3005 <pieterjan.briers+git@gmail.com>
2025-12-15 20:26:17 +01:00

19 lines
839 B
XML

<?xml version="1.0" encoding="utf-8" ?>
<entries>
<entry name="IPrototype">
<remarks>
<para>
It is strongly discouraged to ever construct inheritors of this interface manually, if you need a prototype that
is also runtime-constructable data, consider moving all the data into its own class and using
<see cref="T:Robust.Shared.Serialization.Manager.Attributes.IncludeDataFieldAttribute"/> to flatten it into
the prototype class.
</para>
<para>
Prototypes should <b>never</b> be mutated at runtime, and should be treated as a read only source of truth. Keep
in mind that for example reading a container like a list from the prototype does not make a copy, and you must do
so yourself if you intend to mutate.
</para>
</remarks>
</entry>
</entries>