Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve description of GetNodeOrDefault in C# API #71168

Merged
merged 1 commit into from
Jan 11, 2023
Merged

Improve description of GetNodeOrDefault in C# API #71168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 2 additions & 7 deletions modules/mono/glue/GodotSharp/GodotSharp/Core/Extensions/NodeExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,13 +48,8 @@ public T GetNode<T>(NodePath path) where T : class
}

/// <summary>
/// Fetches a node. The <see cref="NodePath"/> can be either a relative path (from
/// the current node) or an absolute path (in the scene tree) to a node. If the path
/// does not exist, a <see langword="null"/> instance is returned and an error
/// is logged. Attempts to access methods on the return value will result in an
/// "Attempt to call &lt;method&gt; on a null instance." error.
/// Note: Fetching absolute paths only works when the node is inside the scene tree
/// (see <see cref="IsInsideTree"/>).
/// Similar to <see cref="GetNode"/>, but does not log an error if <paramref name="path"/>
/// does not point to a valid <see cref="Node"/>.
/// </summary>
/// <example>
/// Example: Assume your current node is Character and the following tree:
Expand Down