AddOn Studio

Engine:CCMD run: Difference between revisions

Engine Talk

Engine:CCMD run (source)

Revision as of 21:36, 16 October 2023

1,938 bytes added ,  16 October 2023
→‎More examples
 
(39 intermediate revisions by the same user not shown)
Line 18: Line 18:
== Examples ==
== Examples ==
=== Default values ===
=== Default values ===
For a script file named 'startup.cfg' and looks like:
For a script file named 'startup.cfg' which looks like:
<kua>
<kua>
echo fred
echo fred
Line 39: Line 39:
</kua>
</kua>
: In this case: echos 'fred' to console, runs a Lua statement that adds '1 + 3' and prints the result, creates an alias 'bob', creates 'fred' variable that the alias 'bob' will show the value of, runs the 'bob' alias that effectively prints the value of 'fred' that is 'james'.
: In this case: echos 'fred' to console, runs a Lua statement that adds '1 + 3' and prints the result, creates an alias 'bob', creates 'fred' variable that the alias 'bob' will show the value of, runs the 'bob' alias that effectively prints the value of 'fred' that is 'james'.
=== Multiline strings ===
Strings in the base scripting language are intrinsically multiline.
* For a script file named 'startup.cfg' which looks like:
<kua>
echo 'fred
bob'
alias bob "
    lua run '
        local a = 5
        print(a + 1 + 3)
    '
"
bob
</kua>
* Run the example script file.
<kua>
> run startup.cfg
fred
bob
9
</kua>
: Here the echo prints across two lines. An alias is created with an embedded block of lua that runs via the 'lua' context 'run' command, which uses single quotes to not conflict with the outer double quotes. Then bob is run and the whole thing prints 9.


== Script syntax ==
== Script syntax ==
Line 48: Line 72:
<kua>print bob; bind U +attack // changing binding</kua>
<kua>print bob; bind U +attack // changing binding</kua>


=== Addendum I: ===
=== Statements ===
:1. Matching '{' and '}' can be used as third set of quotes to delimit other-text, as in main section item 8.
 
=== Statements: ===
:1. 'Statement' is a text block that begins with a command name, and is followed by any other text, and ends with line-end or semi-colon. A new statement can begin adjacent to the previous statements ending delimiter.
:1. 'Statement' is a text block that begins with a command name, and is followed by any other text, and ends with line-end or semi-colon. A new statement can begin adjacent to the previous statements ending delimiter.
::<kua>statement[\n;]statement[\n;]...</kua>
::<kua>statement[\n;]statement[\n;]...</kua>
Line 67: Line 88:
::<kua>co</kua>
::<kua>co</kua>
::<kua>commandcommand...63</kua>
::<kua>commandcommand...63</kua>
:7. 'Other text' may contain quoted text, where '<nowiki>'</nowiki>' or '"' are valid quote begin and end quote characters.
:7. 'Other text' may contain quoted text, where '<nowiki>'</nowiki>' or '"' or '`' are valid quote begin and end quote characters.
::<kua>command 'other' "text"</kua>
::<kua>command 'other' "text"</kua>
:8. If quoted text is found, any semi-colons, line-ends, or comment starts will be ignored, until next matching quote character.
:8. If quoted text is found, any semi-colons, line-ends, or comment starts will be ignored, until next matching quote character.
<kua>command 'other;
:<kua>command 'other;' "//text"</kua>
' "//text"</kua>
<kua>command 'other
:: In this case 'command other\n statement' will be treated as one statement, and the statement does not end after the 'other;'.
' "text"</kua>
:: In this case will be treated as one statement, where the statement does not end after the 'other' and the newline is included in the parameter, like 'other\n'.
:9. No other checking or processing is done on any 'other text' after the command name, and any actual meaning is context-dependent and determined when the actual statement is run.
:9. No other checking or processing is done on any 'other text' after the command name, and any actual meaning is context-dependent and determined when the actual statement is run.
::<kua>command other text</kua>
::<kua>command other text</kua>
Line 82: Line 104:
:12. 'Executable statements' are composed of both the parsed 'command name' and 'other text' components, excluding comments
:12. 'Executable statements' are composed of both the parsed 'command name' and 'other text' components, excluding comments


=== Parameters: ===
=== Parameters ===
'Statements' intrinsically contain only a 'command' and the optional 'other text'. A command can treat the 'other text' as a whole parameter, or as divided into multiple parameters.
'Statements' intrinsically contain only a 'command' and the optional 'other text'. A command can treat the 'other text' as a whole parameter, or as divided into multiple parameters.


Line 109: Line 131:
: 'set' now treats james as part of the second parameter, and the quotes themselves are stripped.
: 'set' now treats james as part of the second parameter, and the quotes themselves are stripped.


==== Parameter delimiters: ====
==== Delimiters ====
:1. space - any whitespace
:1. space - any whitespace
<kua>
<kua>
Line 128: Line 150:
'bob' is 'fred james'
'bob' is 'fred james'
</kua>
</kua>
 
:3. back tick - any text within a set of back ticks will be a single parameter, and the ticks will be stripped.
==== Special parameter delimiters: ====
<kua>
:4. curly braces - Can be used to extend a whole 'statement' or set of statements across multiple lines. Can not be used as a parameter delimiter. The contents will be treated as one statement block.
> set bob `fred james`
::''Note: Only useful in a multiline script file, and only works for default commands, like in the 'lua' and 'js' contexts, to pass a multi-line code block to the default command, for passing to the Lua and JS runtimes.''
> bob
In a script named 'startup.cfg':
'bob' is 'fred james'
</kua>
==== Special delimiters ====
:1. Back ticks surrounding text passed directly to a context will be stripped. Normally all text is passed verbatim, including quotes. Back ticks effectively treat the rest of the statement as a block for a multi-line statement. Quotes are not removed normally as they may be important to the context's command processing. Back ticks are special in that they will be removed from the start and end of the script statement. Without this special behavior, there would be no way to run a multi-line command block for an associated context, without switching to it first.
<kua>
<kua>
alias testscript '
> lua `print "bob"`
context lua
bob
{
print("Lua")
local s = ""
for i = 10, 1, -1 do
s = s .. i .. " "
end
io.write(s)


print("print bob"..s)
> lua `
}
  print "bob"
exit
  print "bob"
`
bob
bob


context js
> lua '
{
  print "bob"
print("JavaScript");
  print "bob"
var s = "";
'
for (i = 10; i >= 1; i--) s += i + " ";
Error in : [string "'print "bob"'"]:1: unexpected symbol near ''print "bob"'' (3)
print(s);
</kua>


//script("print bob" + s);
== More examples ==
//return 0;
Direct context with out back ticks:
}
<kua>
exit
> lua print "bob"
'
bob
bind U testscript
> lua 'print "bob"'
Error in : [string "'print "bob"'"]:1: unexpected symbol near ''print "bob"'' (3)
> lua run 'print "bob"'
bob
</kua>
: When addressing the context directly, all of the 'other text' that is not the command simply gets passed to the context. At the top, print "bob" gets run in 'lua' context. The second fails as 'print "bob"' is not valid for the context or Lua. The third runs usingthe run command as a normal parameter to 'run'. While it will run multiline Lua scripts, text still won't be running as a set of context commands.
<kua>
> lua `
  print "bob"
  print "bob"
`
bob
bob
</kua>
: Here effectively as a block inside 'lua'
<kua>
> context lua
> print "bob"
bob
> print "bob"
bob
> context global
</kua>
: And same thing but switching and executing and switching back.
<kua>
> notthere `
  print(1+2)
  print(1+2)
`
Unknown: notthere
</kua>
: The context did not exist and didn't run the block. In this case, guards against running commands in wrong context, if the context didn't exist at that time.
<kua>
> context notthere
> print(1+2)
Unknown: print(1+2)
> print(1+2)
Unknown: print(1+2)
> context global
</kua>
</kua>
: This time commands are run in the unintended context.


== Notes ==
== Notes ==
*
*
Retrieved from "https://addonstudio.org/wiki/Special:MobileDiff/21584...21624"