Skip to main content

#Xs.user.script(...)

Call a script from within another script.

'Subscripts' are used to interact with other user scripts by hardcoding a call to them in your own script. This is distinct from scriptors, which are provided on the command line by the user.

Syntax

#Xs.user.script(args)

Where Xs is the security level you wish to call the subscript at.

LetterNumberSecurity Level
#fs#4sFULLSEC
#hs#3sHIGHSEC
#ms#2sMIDSEC
#ls#1sLOWSEC
#ns#0sNULLSEC

Arguments

args

An object containing the arguments to call the subscript with.

Example

Let user.my_script be a hypothetical user script, which returns the user's upgrades by calling sys.upgrades:

function(context, args) {
return #hs.sys.upgrades(args)
}

This script is HIGHSEC due to the sys.upgrades call, and thus is subscripted with a subscript call, at HIGHSEC or lower.

function(context, args) {
return #hs.user.my_script({full:true})
}

sys.upgrades will return its subscripted full: true output, due to the arguments passed to user.my_script being given directly to sys.upgrades in the subscript chain.

If the top-level script attempts to call user.my_script at a higher seclevel (like FULLSEC), an error is returned:

function(context, args) {
return #fs.user.my_script({full:true})
}
{ok:false, msg:"Security level guarantee failed: user.top_level_script required level >= 4; but user.my_script is level 3"}