diff options
| author | Rémi Verschelde <remi@verschelde.fr> | 2021-07-14 00:04:43 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-07-14 00:04:43 +0200 |
| commit | c0da57699bcc77951fe93a718f9da214fe640dd8 (patch) | |
| tree | 315d441511c84403bb1475a72e6e25b7ed3936b3 /modules/visual_script/doc_classes/VisualScriptYield.xml | |
| parent | 8b0a85ce9841d2051eced9adbb41ff6d360937d2 (diff) | |
| parent | 105495646191f2758779256589cac1aa5c583cdc (diff) | |
| download | redot-engine-c0da57699bcc77951fe93a718f9da214fe640dd8.tar.gz | |
Merge pull request #42753 from KoBeWi/vs_docs
Document remaining Visual Script classes
Diffstat (limited to 'modules/visual_script/doc_classes/VisualScriptYield.xml')
| -rw-r--r-- | modules/visual_script/doc_classes/VisualScriptYield.xml | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/modules/visual_script/doc_classes/VisualScriptYield.xml b/modules/visual_script/doc_classes/VisualScriptYield.xml index 0a8d529a48..b04ab7b014 100644 --- a/modules/visual_script/doc_classes/VisualScriptYield.xml +++ b/modules/visual_script/doc_classes/VisualScriptYield.xml @@ -1,8 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="VisualScriptYield" inherits="VisualScriptNode" version="4.0"> <brief_description> + A Visual Script node used to pause a function execution. </brief_description> <description> + [VisualScriptYield] will pause the function call and return [VisualScriptFunctionState], which can be used to resume the function. </description> <tutorials> </tutorials> @@ -10,16 +12,21 @@ </methods> <members> <member name="mode" type="int" setter="set_yield_mode" getter="get_yield_mode" enum="VisualScriptYield.YieldMode" default="1"> + The mode to use for yielding. See [enum YieldMode] for available options. </member> <member name="wait_time" type="float" setter="set_wait_time" getter="get_wait_time"> + The time to wait when [member mode] is set to [constant YIELD_WAIT]. </member> </members> <constants> <constant name="YIELD_FRAME" value="1" enum="YieldMode"> + Yields during an idle frame. </constant> <constant name="YIELD_PHYSICS_FRAME" value="2" enum="YieldMode"> + Yields during a physics frame. </constant> <constant name="YIELD_WAIT" value="3" enum="YieldMode"> + Yields a function and waits the given time. </constant> </constants> </class> |