SetFunctionValue

A function added by the New Vegas Script Extender.

Description

Added by NVSE V4. Used only within the 'Function' block type of a User Defined Function, sets the return value to that specified. A UDF may return only a single value, but it may be of any type, including an array.

If the function is called multiple times in the same function, the most recent is used by the call; this function is not a substitute for the keyword 'return', script execution will continue to the end of the block as normal.

Syntax

[help]

(None) SetFunctionValue UDFReturnValue:multi

Example

Begin Function { }

    SetFunctionValue SunnyREF ; * this function simply returns Sunny Smiles

End

Begin Function { }
   
    if GameHour > 12
        SetFunctionValue 1

    elseif eval (PlayerREF.GetAV Strength > 5)
        SetFunctionValue 1

    else
        SetFunctionValue 0

    endif

    ; * return true if it is after midday or player has more than 5 strength

End

See Also

• User Defined Function
• Call
• Array Variables
• Eval