diff options
| author | nlupugla <lupu.gladstein@gmail.com> | 2023-09-17 14:38:44 -0400 |
|---|---|---|
| committer | nlupugla <lupu.gladstein@gmail.com> | 2023-12-13 13:30:28 -0500 |
| commit | cd221c1816fe1ffa9c0e730667ade2940dd14632 (patch) | |
| tree | ca13ddd69c6ea9bce23bc9f39bc629174f7ab3d4 /doc/classes/NodePath.xml | |
| parent | b94eb58d35b3dd8a9f522bc90df0db73862ef326 (diff) | |
| download | redot-engine-cd221c1816fe1ffa9c0e730667ade2940dd14632.tar.gz | |
Added NodePath::slice method.
Diffstat (limited to 'doc/classes/NodePath.xml')
| -rw-r--r-- | doc/classes/NodePath.xml | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/classes/NodePath.xml b/doc/classes/NodePath.xml index 553a3913d8..a13813aa70 100644 --- a/doc/classes/NodePath.xml +++ b/doc/classes/NodePath.xml @@ -183,6 +183,16 @@ Returns [code]true[/code] if the node path is empty. </description> </method> + <method name="slice" qualifiers="const"> + <return type="NodePath" /> + <param index="0" name="begin" type="int" /> + <param index="1" name="end" type="int" default="2147483647" /> + <description> + Returns the slice of the [NodePath], from [param begin] (inclusive) to [param end] (exclusive), as a new [NodePath]. + The absolute value of [param begin] and [param end] will be clamped to the sum of [method get_name_count] and [method get_subname_count], so the default value for [param end] makes it slice to the end of the [NodePath] by default (i.e. [code]path.slice(1)[/code] is a shorthand for [code]path.slice(1, path.get_name_count() + path.get_subname_count())[/code]). + If either [param begin] or [param end] are negative, they will be relative to the end of the [NodePath] (i.e. [code]path.slice(0, -2)[/code] is a shorthand for [code]path.slice(0, path.get_name_count() + path.get_subname_count() - 2)[/code]). + </description> + </method> </methods> <operators> <operator name="operator !="> |