[INDEX] General Commands

[Saetan]

MSCI Script Commands Index

• General Commands
• Audio Commands
• Logbook Commands
• Fly Commands
• Trade Commands
• General Object Commands
• Universe and Sector Commands
• Other

(x ... marks unlinked script commands)
----- ----- ----- ----- -----


»» General Commands

• »» Flow Control
  • end conditional
  • else
  • continue
  • break
  • goto label <Label>
  • gosub <Label>
  • define label <Label>
  • endsub
  »» Script Calls
  • @ <RetVar/IF/Start><RefObj> call script <Script Name> : <Parameter>
  • x <RefObj> interrupt with script <Script Name> and prio <Var/Number>: arg1=<Value> arg2=<Value> arg3=<Value> arg4=<Value>
  • x <RefObj> interrupt task <Var/Number> with script <Script Name> and prio <Var/Number>: arg1=<Value> arg2=<Value> arg3=<Value> arg4=<Value>
  • x <RefObj> start task <Var/Number> with script <Script Name> and prio <Var/Number>: arg1=<Value> arg2=<Value> arg3=<Value> arg4=<Value>
  • x return <Value>
  • x <RetVar/IF><RefObj> is script <Script Name> on stack of task=<Var/Number>
  • x <RetVar/IF><RefObj> is task <Var/Number> in use
  • x <RetVar/IF><RefObj> call named script: name=<Var/String>, <Value>, <Value>, <Value>, <Value>, <Value>
  • x <RefObj> start named script: task=<Var/Number> scriptname=<Var/String> prio=<Var/Number>, <Value>, <Value>, <Value>, <Value>, <Value>
  • x <RetVar> = <RefObj> get next available task: starting <Var/Number>
  • x <RefObj> interrupt with script <Script Name> and prio <Var/Number>
  »» Arrays
  • <RetVar> = array alloc: size=<Var/Number>
  • <RetVar/IF><Var/Array>[<Var/Number>]
  • <Var/Array>[<Var/Number>] = <Value>
  • <RetVar/IF><Var/Array>[<Var/Number>][<Var/Number>]
  • <Var/Array>[<Var/Number>][<Var/Number>] = <Value>
  • <RetVar/IF> size of array <Var/Array>
  • <RetVar> = clone array <Var/Array> : index <Var/Number> … <Var/Number>
  • copy array <Var/Array> index <Var/Number> … <Var/Number> into array <Var/Array> at index <Var/Number>
  • insert <Value> into array <Var/Array> at index <Var/Number>
  • append <Value> to array <Var/Array>
  • remove element from array <Var/Array> at index <Var/Number>
  • resize array <Var/Array> to <Var/Number>
  • <RetVar> = get index of <Value> in array <Var/Array> offset=<Var/Number> + 1
  • <Var/Array>[<Var/Number>] = <Var/Array>[<Var/Number>]
  • <RetVar> = sort array <Value>
  • <RetVar> = sort array: data=<Value> sort values=<Value>
  • <RetVar/IF> find <Value> in array: <Value>
  • <RetVar> = create new array, arguments=<Value>, <Value>, <Value>, <Value>, <Value>
  • <RetVar/IF> reverse array <Value>
  • <RetVar/IF> arrays <Value> and <Value> are equal
  »» Strings
  • <RetVar/IF> get length of string <Var/String>
  • <RetVar> = find position of pattern <Var/String> in <Var/String>
  • <RetVar> = get substring of <Var/String> offset=<Var/Number> length=<Var/Number>
  • <RetVar> = string <Var/String> to integer
  • <RetVar> = substitute in string <Var/String>: pattern <Var/String> with <Var/String>
  • <RetVar> = convert number <Var/Number> to string
  • <RetVar> = format time: <Var/Number>
  • <RetVar/IF> match regular expression: <Var/String> to string <Var/String>
  • <RetVar/IF> get string font length: <Var/String>
  »» Math
  • x <RetVar> = = fixed sin <Var/Number>
  • x <RetVar> = = fixed cos <Var/Number>
  • x <RetVar> = square root of <Var/Number>
  »» Commands/Signals
  • WiP <RefObj> connect ship command/signal <Object Command/Signal> to script <Script Name> with prio <Var/Number>
  • x <RefObj> set ship command/signal <Object Command/Signal> to global default behaviour
  • x <RefObj> ignore ship command/signal <Object Command/Signal>
  • x <RefObj> add secondary signal: signal=<Object Signal>, script=<Script Name>, prio=<Var/Number>, name=<Var/String>
  • x <RefObj> remove secondary signal: signal=<Object Signal>, name=<Var/String>
  • x global secondary signal map: add signal=<Object Signal> race=<Var/Race> class=<Var/Class> script=<Script Name> prio=<Var/Number> name=<Var/String>
  • x global secondary signal map: remove signal=<Object Signal> race=<Var/Race> class=<Var/Class> name=<Var/String>
  • x global script map: set key=<Object Command/Signal>, class=<Var/Class>, race=<Var/Race>, script=<Script Name>, prio=<Var/Number>
  • x global script map: remove key=<Object Command/Signal>, class=<Var/Class>, race=<Var/Race>
  • x global script map: ignore key=<Object Command/Signal>, class=<Var/Class>, race=<Var/Race>
  • x set script command upgrade: command=<Object Command/Signal> upgrade=<Var/Ware>
  • x <RetVar> = get script command upgrade: command=<Object Command/Signal>
  • x set script command upgrade: command=<Object Command/Signal> upgrade=<Var/Ware> script=<Script Name>
  • x set ship command preload script: command=<Object Command/Signal> script=<Script Name>
  • x global script map for wings: key=<Var/Wing Command> race=<Var/Race> script=<Script Name> prio=<Var/Number>
  • x set script command upgrade: wing command=<Var/Wing Command> upgrade=<Var/Ware>
  • x set script command upgrade: wing command=<Var/Wing Command> upgrade=<Var/Ware> script=<Script Name>
  • x set wing command preload script: wing command=<Var/Wing Command> script=<Script Name>
  • x add ship custom command: id=<Var/Number>
  • x remove ship custom command: id=<Var/Number>
  • x <RetVar> = ship custom command exists: id=<Var/Number>
  • x set script command: <Object Command/Signal>
  • x <RetVar/IF> = get script command
  • x set script command target: <Value>
  • x <RetVar/IF> get script command target
  • x <RefObj> connect wing command/signal <Object Command/Signal> to script <Script Name> with prio <Var/Number>
• <RetVar/IF><Expression>
• inc <RetVar> =
• dec <RetVar> =
• @ <RetVar/IF> wait <Var/Number> ms
• @ <RetVar/IF> wait randomly from <Var/Number> to <Var/Number> ms
• <Var/Number> = random value from 0 to <Var/Number> -1
• <Var/Number> = random value from <Var/Number> to <Var/Number> -1
• * <Comment>
• <RetVar> = script engine version
• <RetVar> = get script version
• x <RetVar/IF> is a new script version available
• <RetVar> = get script name
• <RetVar> = = get script priority
• set script priority to <Var/Number>
• infinite loop detection enabled=<Var/Number>
• <RetVar/IF> is script with prio <Var/Number> on stack
• <RetVar/IF> get task ID
• <RetVar/IF> get PID
• enable signal/interrupt handling: <Var/Number>
• <RetVar/IF> is signal/interrupt handling on
• WiP <RefObj> set local variable: name=<Var/String> value=<Value>
• WiP <RetVar/IF><RefObj> get local variable: name=<Var/String>
• WiP set global variable: name=<Var/String> value=<Value>
• WiP <RetVar/IF> get global variable: name=<Var/String>
• <RetVar> = datatyp[ <Value> ]
• <RetVar/IF> is datatyp[ <Value> ] == <Var/Script Data Type>
• <RetVar> = read text: page=<Var/Number> id=<Var/Number>
• <RetVar/IF> = read text: page id=<Var/Number>, from <Var/Number> to <Var/Number> to array, include empty=<Var/Boolean>
• <RetVar/IF> = read text: page id=<Var/Number>, id=<Var/Number> exists
• <RetVar> = sprintf: fmt=<Var/String>, <Value>, <Value>, <Value>, <Value>, <Value>
• <RetVar> = sprintf: pageid=<Var/Number> textid=<Var/Number>, <Value>, <Value>, <Value>, <Value>, <Value>
• load text: id=<Var/Number>
• WiP <RetVar/IF> state of news article: page=<Var/Number> id=<Var/Number>
• WiP set state of news article page=<Var/Number> id=<Var/Number> to <Var/Number>
• <RetVar/IF> system date is month=<Var/Number>, day=<Var/Number>
• <RetVar> = playing time
• <RetVar/IF> is plot <Var/Number> state flag <Var/Number>
• <RetVar> = register hotkey <Var/String> to call script <Script Name>
• <RetVar> = register hotkey <Var/String> to call script name <Var/String>
• unregister hotkey <Var/Number>
• <RetVar> = last load time
• WiP <RetVar/IF><RefObj> get all local variable keys, starting with=<Var/String>
• WiP <RetVar/IF> get all global variable keys, starting with=<Var/String>
• WiP <RetVar/IF><RefObj> get local variables: regular expression=<Var/String>
• WiP <RetVar/IF> get global variables: regular expression=<Var/String>
• WiP <RetVar> = get maximum, <Var/Number>, <Var/Number>, <Var/Number>, <Var/Number>, <Var/Number>