Add missing docs for assert message in GDScript
Seems like this was overlooked in PR #31142. See also issue #17082.
This commit is contained in:
parent
ece425ace4
commit
4c3c73ef9c
2 changed files with 7 additions and 1 deletions
modules/gdscript
|
@ -90,14 +90,18 @@
|
|||
</return>
|
||||
<argument index="0" name="condition" type="bool">
|
||||
</argument>
|
||||
<argument index="1" name="message" type="String" default="""">
|
||||
</argument>
|
||||
<description>
|
||||
Asserts that the [code]condition[/code] is [code]true[/code] . If the [code]condition[/code] is [code]false[/code], an error is generated and the program is halted until you resume it. Only executes in debug builds, or when running the game from the editor. Use it for debugging purposes, to make sure a statement is [code]true[/code] during development.
|
||||
Asserts that the [code]condition[/code] is [code]true[/code]. If the [code]condition[/code] is [code]false[/code], an error is generated and the program is halted until you resume it. Only executes in debug builds, or when running the game from the editor. Use it for debugging purposes, to make sure a statement is [code]true[/code] during development.
|
||||
The optional [code]message[/code] argument, if given, is shown in addition to the generic "Assertion failed" message. You can use this to provide additional details about why the assertion failed.
|
||||
[codeblock]
|
||||
# Imagine we always want speed to be between 0 and 20
|
||||
speed = -10
|
||||
assert(speed < 20) # True, the program will continue
|
||||
assert(speed >= 0) # False, the program will stop
|
||||
assert(speed >= 0 && speed < 20) # You can also combine the two conditional statements in one check
|
||||
assert(speed < 20, "speed = %f, but the speed limit is 20" % speed) # Show a message with clarifying details
|
||||
[/codeblock]
|
||||
</description>
|
||||
</method>
|
||||
|
|
|
@ -430,6 +430,8 @@ void GDScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const
|
|||
mi.name = "assert";
|
||||
mi.return_val.type = Variant::NIL;
|
||||
mi.arguments.push_back(PropertyInfo(Variant::BOOL, "condition"));
|
||||
mi.arguments.push_back(PropertyInfo(Variant::STRING, "message"));
|
||||
mi.default_arguments.push_back(String());
|
||||
p_functions->push_back(mi);
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in a new issue