How to read the C# API reference
Start with the signature and object lifetime, then validate the call result.
Find the exact symbol
Search for Entity.GetEntity, Expression.Parse or the required type. Check its base type, overload and C# signature. An inherited method may be documented on the base page; a subclass having no declaration does not mean the method is absent.
Read the signature as a contract
| Element | Check |
|---|---|
| static | Whether a call needs an instance |
| Parameter type | int/long, float/double and Entity/Resource are not automatically interchangeable |
| Default value | What happens when an argument is omitted |
| Return type | bool, Error, object and Variant require different checks |
| virtual/override | A callable method or a callback to override |
For example, Parse returns Error: compare it with Error.Ok first. Execute returns Variant, while HasExecuteFailed separately reports execution failure. GetErrorText can retain old text after a successful Execute.
Use the C# call shape
Use GetEntity rather than get_entity and preserve exact _Ready/_PhysicsProcess callback names. For a dynamic C# TryAdd method, use MethodName.TryAdd: snake_case aliases are not generated automatically. A signature does not certify network authority, thread safety or gameplay validity.
Check preconditions: is the object still valid, must it be in EntityTree and is an exported resource required? Handle null or an Error other than Ok before accessing the next property.
Expression example · Dynamic boundary · Expression reference