SCP SEXPs

This page is a reference of SEXPs that are only available in the SCP version of FRED. This also includes any retail SEXPs that have been modified from their original behaviour. To see the list of SEXPs that are available in retail FRED, go to the Retail SEXPs page. For tips and examples for how to properly use a SEXP when building missions, as well as warnings about potential pitfalls, follow the link to the detail page for the SEXP you are interested in.

Time

None

Arithmetic

rand-multiple

rand-multiple 
    Rand-multiple (Arithmetic operator) 
    Gets a random number. This number can and will change between successive calls to this sexp. 
  
    Returns a number. Takes 2 or 3 numeric arguments... 
    1: Low range of random number. 
    2: High range of random number. 
    3: (optional) A seed to use when generating numbers. (Setting this to 0 is the same as having no seed at all)

abs

abs 
    Absolute value (Arithmetic operator) 
    Returns the absolute value of a number. Takes 1 numeric argument.

min

min 
    Minimum value (Arithmetic operator) 
    Returns the minimum of a set of numbers. Takes 1 or more numeric arguments.

Status

is-iff

Is IFF (Boolean operator)
	True if ship{s} are all of the specified team.

Returns a boolean value; Takes 2 or more arguments:
/t1:	Team ("friendly", "hostile" or "unknown").
	Rest:	Name of ship to check.

get-object-x

get-object-x
    get-object-x
    Returns the absolute X coordinate of a set of coordinates relative to a particular object (or object's subsystem). The input  
    coordinates are the coordinates relative to the object's position and orientation. If no input coordinates are specified,
    the coordinate returned is the coordinate of the object (or object's subsystem) itself. Takes 1 to 5 arguments...
    1: The name of a ship, wing, or waypoint.
    2: A ship subsystem (or "" if the first argument is not a ship - optional).
    3: The relative X coordinate (optional).
    4: The relative Y coordinate (optional).
    5: The relative Z coordinate (optional).

get-object-y

get-object-y
    get-object-y
    Returns the absolute Y coordinate of a set of coordinates relative to a particular object (or object's subsystem). The input
    coordinates are the coordinates relative to the object's position and orientation. If no input coordinates are specified,
    the coordinate returned is the coordinate of the object (or object's subsystem) itself. Takes 1 to 5 arguments...
    1: The name of a ship, wing, or waypoint.
    2: A ship subsystem (or "" if the first argument is not a ship - optional).
    3: The relative X coordinate (optional).
    4: The relative Y coordinate (optional).
    5: The relative Z coordinate (optional).

get-object-z

get-object-z
    get-object-z
    Returns the absolute Z coordinate of a set of coordinates relative to a particular object (or object's subsystem). The input
    coordinates are the coordinates relative to the object's position and orientation. If no input coordinates are specified,
    the coordinate returned is the coordinate of the object (or object's subsystem) itself. Takes 1 to 5 arguments...
    1: The name of a ship, wing, or waypoint.
    2: A ship subsystem (or "" if the first argument is not a ship - optional).
    3: The relative X coordinate (optional).
    4: The relative Y coordinate (optional).
    5: The relative Z coordinate (optional). 

Change

disable-builtin-messages

Disable builtin messages (Action operator)
        Turns the built in messages sent by command or pilots off
Takes 0 or more arguments....
If no arguments are supplied all built in messages are disabled
        All:    Name of ship to allow to talk.

enable-builtin-messages

Enable builtin messages (Action operator)
        Turns the built in messages sent by command or pilots on
Takes 0 or more arguments...
If no arguments are supplied any ships not given individual silence orders will be able
to send buiilt in messages. Command will also be unsilenced
        All:    Name of ship to allow to talk.

Conditionals

every-time-argument

every-time-argument
    Every-time-argument (Conditional operator)
    This is a version of "when-argument" that will always evaluate its arguments. It's useful in situations where you need to
    repeatedly  check things that may become true more than once. Since this sexp will execute every time it's evaluated,
    you may need to use it as an  argument to "when" (not "when-argument") if you want to impose restrictions on how it's called.

    Takes 3 or more arguments...
    1: The arguments to evaluate (see any-of, all-of, random-of, etc.).
    2: Boolean expression that must be true for actions to take place.
    Rest: Actions to take when the boolean expression becomes true.

Event/Goals

None

Training

None