SQS syntax

From Bohemia Interactive Community
Revision as of 18:23, 29 April 2015 by SilentSpike_bi_wiki (talk | contribs) (Mentioned SQS meaning Status Quo Script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

SQS syntax (where SQS stands for Status Quo Script) was the main syntax in Operation Flashpoint and is still available in Armed Assault. It can only be used for scripts, but not for functions, in the Mission Editor or in addon config files. The alternative syntax is SQF syntax.

Rules

Binding rules:

  • Statements are separated by line breaks and semicolons (;) and commas (,). This means that a statement must not span over multiple lines.
  • Curled braces ({ }) group code to blocks. A block is considered a single statement, thus may not span over multiple lines.

Example:

STATEMENT 1
STATEMENT 2; STATEMENT 3, STATEMENT 4

BLOCK { STATEMENT 5; STATEMENT 6 }

Comments

A line beginning with a semicolon (;) is considered a comment and ignored by the game engine.

Example:

; this is my comment

Language Constructs

The control structures listed in the article Control Structures may also be used in SQS syntax. Note that they must be written within a single line due to the above rules.

Example:

if (_value==1) then {hint "Value is 1"} else {hint "Value is not 1"}

There exist also special structures limited to SQS syntax.

Label

You may define labels in the code by beginning a line with #, followed by the name of the label (without spaces). You may use the command goto at any point of the script to jump to this label.

#Label1

CODE

goto "Label1"

Conditional

You may query a Boolean condition and define code, that is executed only when the condition is true. Note that there is no equivalent for "else". A conditional line must start with ?, followed by the condition and :, followed by one or more commands. Multiple commands are separated by commas (,) or semicolons (;). The conditional statement ends with the end of the line.

? CONDITION : STATEMENT 1; STATEMENT 2

@

Much like the waitUntil statement in SQF syntax, @ will evaluate a certain condition, and the script will pause until @ returns true.

@ CONDITION

Notes

Due to line-based nature of Sqs scripts it is not possible to create multiline string constants in them. To overcome this limitation you can store multiline in separate SQF function files and load them using loadFile or preprocessFile (the second uses C-like preprocessor with // or /* */ comments and #define macros).

Limitations

In OFP v1.96, if a single line of a sqs file is longer than 4096 characters, OFP will return an error and will not execute the line.

See also