Class SpiderFunctionDefinition

constructor

• new SpiderFunctionDefinition(module, type, vars?, body?): SpiderFunctionDefinition

• Parameters

  • module: SpiderModule

  • type: SpiderTypeDefinition

  • vars: SpiderValueType[] = []

  • body: SpiderExpression = ...

  Returns SpiderFunctionDefinition

body

Readonly module

Readonly type

localVariables

• get localVariables(): readonly SpiderValueType[]

• A list containing the types of the local variables defined within this functions body. Does not include parameters.

  Returns readonly SpiderValueType[]

parameters

• get parameters(): readonly SpiderValueType[]

• A list of the parameters of this function.

  Returns readonly SpiderValueType[]

results

• get results(): readonly SpiderValueType[]

• A list of the results of this function. Empty for functions which return nothing.

  Returns readonly SpiderValueType[]

addLocalVariable

• addLocalVariable(type): SpiderLocalVariableReference

• Adds a new local variable to this function.

  Returns

  A reference to the new local variable.

  Parameters

  • type: SpiderValueType

    The type of the new local variable.

  Returns SpiderLocalVariableReference

addParameter

• addParameter(type): SpiderLocalParameterReference

• Adds a new parameter to this function.

  Returns

  A reference to the new parameter.

  Parameters

  • type: SpiderValueType

    The type of the new parameter.

  Returns SpiderLocalParameterReference

getLocalVariable

• getLocalVariable(index): SpiderLocalVariableReference

• Gets a reference to an existing local variable of this function. Use getParameter for parameters.

  Returns

  A reference to the local variable.

  Parameters

  • index: number

    Ths index of the local variable. Does not include parameters. Local variable 0 is the first non-parameter local.

  Returns SpiderLocalVariableReference

getParameter

• getParameter(index): SpiderLocalParameterReference

• Gets a reference to an existing parameter of this function.

  Returns

  A reference to the parameter.

  Parameters

  • index: number

    The index of the parameter.

  Returns SpiderLocalParameterReference

spliceLocalVariables

• spliceLocalVariables(start, deleteCount, ...items): SpiderValueType[]

• Removes local variables from this function and inserts new ones in their place. Parameters and return values are the same as Javascript's Array.splice method.

  Parameters

  • start: number

  • deleteCount: number

  • Rest ...items: SpiderValueType[]

  Returns SpiderValueType[]