Files
RobustToolbox/Robust.Shared/GameObjects/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

15 lines
651 B
XML

<entries>
<entry name="EntityQueryResolve">
<summary>
Attempts to look up <typeparamref name="TComp1"/> on the given entity, writing it into the given space
if it finds it and the space was not already empty.
</summary>
<remarks>
This is preferable to
<see cref="M:Robust.Shared.GameObjects.EntityQuery`1.TryComp(Robust.Shared.GameObjects.EntityUid,`0@)"/> if it
is erroneous for the component to not be present, but you don't want to crash the game.<br/>
This is also preferable if you may have already looked up the component, saving on lookup time.
</remarks>
</entry>
</entries>