[SF] Misc. Functions

Last updated for version v0.3.2

Main Info

This is the page where all of the documentation on Starfall functions is. If you find any bugs, please report them to the Issues page.

Documentation

Functions

playerex.lua (SHARED Module)

    --- Sets the angle of the player's view (may rotate body too if angular difference is large)
    -- [VExtensions]
    -- @shared
    -- @param Angle angle to set player's eye angles to.
    function player_methods:setEyeAngles(ang)
        ...
    end

    --- Returns whether the player trusts player ply.
    -- Behaves like prior wiremod before Sparky nerfed it so you couldn't get the friends of people you weren't friends with.
    -- [VExtensions]
    -- @shared
    -- @param Player ply to check if player trusts.
    -- @return bool Whether player trusts player "ply".
    function player_methods:trusts(ply)
        ...
    end

printlocal.lua (CLIENT Module)

    --- If the LocalPlayer has vextensions.printLocal enabled, prints to their chat.
    -- This uses chat.AddText.
    -- [VExtensions]
    -- @param ... Varargs of any type, use colors before variables to change the color of those variables as strings.
    function builtins_library.printLocal(...)
        ...
    end

    --- Returns the max amount of characters and arguments you can use in a printLocal call.
    -- Internally looks at the convars vex_printlocal_argmax and vex_printlocal_charmax.
    -- [VExtensions]
    -- @return number Max amount of characters in total you can use in a printLocal call.
    -- @return number Max amount of arguments you can use in a printLocal call.
    function builtins_library.printLocalLimits()
        ...
    end

    --- Returns whether you can printLocal.
    -- This only returns the burst limit and not whether the user has printLocal enabled.
    -- If you want to check if they have it enabled, see hasPermission and the vextensions.printLocal permission.
    -- [VExtensions]
    -- @return bool Whether you can call printLocal.
    function builtins_library.canPrintLocal()
        ...
    end

See more in-depth examples in our Discussions