goto: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[SQS[ _]syntax" to "[[SQS Syntax")
m (Text replacement - "{{Feature | Warning | " to "{{Feature|warning|")
 
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00
 
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|gr1= Program Flow
|gr1= Program Flow


|1.00
|descr= Break script flow and go to given label (defined by '''#''' - '''NOT''' to be confused with [[SQF Syntax|SQF]]'s [[a_hash_b|hash sign]]!)
{{Feature|warning|This command only works in [[SQS Syntax]].}}
{{Feature|informative|Note that labels are not case sensitive and are searched for from the top of the script, so multiple occurrences of a label will only result in the topmost one ever being found.}}


| Break script flow and go to given label (defined by '''#''' - '''NOT''' to be confused with [[SQF Syntax|SQF]]'s [[a_hash_b|hash sign]]!)
|s1= [[goto]] label
{{Feature | Warning | This command only works in [[SQS Syntax]].}}
{{Feature | Informative | Note that labels are not case sensitive and are searched for from the top of the script, so multiple occurrences of a label will only result in the topmost one ever being found.}}
 
| [[goto]] label


|p1= label: [[String]]
|p1= label: [[String]]


| [[Nothing]]
|r1= [[Nothing]]


|x1= <code>[[goto]] "myLabel"
|x1= <sqs>
[[player]] [[setDamage]] 1
goto "myLabel"
player setDamage 1


'''#'''myLabel
#myLabel
[[hint]] "you successfully avoided death!"</code>
hint "you successfully avoided death!"
</sqs>


| [[Control_Structures#SQS_syntax_.28deprecated.29|SQS Control Structures]], [[SQS to SQF conversion]]
|seealso= [[Control_Structures#SQS_syntax_.28deprecated.29|SQS Control Structures]] [[SQS to SQF conversion]]
}}
}}


<dl class="command_description">
{{Note
<!-- Note Section BEGIN -->
|user= Hardrock
 
|timestamp= 20060804105200
<dd class="notedate">Posted on August 4, 2006 - 10:52</dd>
|text= ''Notes from before the conversion:''
<dt class="note">[[User:Hardrock|hardrock]]</dt>
<dd class="note">''Notes from before the conversion:''


* This function works only inside of [[SQS Syntax|SQS script]].
* This function works only inside of [[SQS Syntax|SQS script]].
Line 38: Line 55:
* Labels are not case sensitive.
* Labels are not case sensitive.
* Loops which look something like the example below should be avoided as many of them could cause the mission to slow down:
* Loops which look something like the example below should be avoided as many of them could cause the mission to slow down:
<code>#wait
<sqs>
[[if]] (condition) [[then]] {[[goto]] "wait"}</code>
#wait
if (condition) then { goto "wait" }
</sqs>


It is better to use the '''@''' command to wait for a condition to be true, or put a small delay into the wait loop.
It is better to use the '''@''' command to wait for a condition to be true, or put a small delay into the wait loop.
Line 48: Line 67:
* You would need to have many scripts running for this to be a significant issue.
* You would need to have many scripts running for this to be a significant issue.
* Deciding whether to use a script with a loop or a trigger or even a '''@''' statement to detect a condition is a complicated matter and should be subject to experimentation.
* Deciding whether to use a script with a loop or a trigger or even a '''@''' statement to detect a condition is a complicated matter and should be subject to experimentation.
}}


<dd class="notedate">Posted on August 4, 2006 - 12:17</dd>
{{Note
<dt class="note">[[User:UNN|UNN]]</dt>
|user= UNN
<dd class="note">
|timestamp= 20060804121700
A goto command called within a [[forEach]] loop will only execute a single jump to [[goto]], once the [[forEach]] loop has finished:
|text= A goto command called within a [[forEach]] loop will only execute a single jump to [[goto]], once the [[forEach]] loop has finished:
{[[goto]] "wait"} [[forEach]] [0, 1, 2, 3, 4]
<sqs>{ goto "wait" } forEach [0, 1, 2, 3, 4]</sqs>
 
}}
<!-- Note Section END -->
</dl>
 
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 21:46, 16 May 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Break script flow and go to given label (defined by # - NOT to be confused with SQF's hash sign!)
⚠
This command only works in SQS Syntax.
ⓘ
Note that labels are not case sensitive and are searched for from the top of the script, so multiple occurrences of a label will only result in the topmost one ever being found.
Groups:
Program Flow

Syntax

Syntax:
goto label
Parameters:
label: String
Return Value:
Nothing

Examples

Example 1:
goto "myLabel" player setDamage 1 #myLabel hint "you successfully avoided death!"

Additional Information

See also:
SQS Control Structures SQS to SQF conversion

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Hardrock - c
Posted on Aug 04, 2006 - 10:52 (UTC)
Notes from before the conversion:
  • This function works only inside of SQS script.
  • The search for labels always begins at the top of the script so that if there are multiple occurrences of a label the first occurrence will always be the one found.
  • Because of the searching order, it is faster to place loops which are executed often at the top of a script.
  • Labels are not case sensitive.
  • Loops which look something like the example below should be avoided as many of them could cause the mission to slow down:
#wait if (condition) then { goto "wait" }
It is better to use the @ command to wait for a condition to be true, or put a small delay into the wait loop. Example:
  • While it is not required to include a delay in a loop, such a loop without a delay can cause the script to slow the game down, as the loop will be executed many times before the game engine interrupts the script.
  • Unless you really want the loop to execute multiple times during a frame, you should include a small delay.
  • You would need to have many scripts running for this to be a significant issue.
  • Deciding whether to use a script with a loop or a trigger or even a @ statement to detect a condition is a complicated matter and should be subject to experimentation.
UNN - c
Posted on Aug 04, 2006 - 12:17 (UTC)
A goto command called within a forEach loop will only execute a single jump to goto, once the forEach loop has finished:
{ goto "wait" } forEach [0, 1, 2, 3, 4]
Retrieved from "https://community.bistudio.com/wiki?title=goto&oldid=364521"