Skip to content

BoundFunc


Members

arguments

desc: The array of arguments bound to this function.

type: array

default: empty array

meta: [object]

function

desc: The function that has arguments bound to it.

type: Func|BoundFunc

meta: [object]

Methods

__Get

__Get(key)

Meta function allowing access to the underlying bound function as thought it was this function except if the arguments member is retrieved.

parameters

name: key

desc: The key to look up in the object.

type: any

return value

desc: The looked up value.

type: any

__GetInstanceType

__GetInstanceType(object)

Constructs the class path of a class instance.

parameters

name: object

desc: The object to retrieve the class path from.

type: object

return value

desc: Class path.

type: string

__IsInstanceOf

__IsInstanceOf(object, class)

Checks if a class is in the class path of an object.

parameters

name: object

desc: The class instance to search.

type: string|number|object

name: class

desc: The class name to search for.

type: string|number|object

return value

desc: Whether or not the class path of object contains class.

type: bool

__New

__New(fun, arguments*)

Constructor.

parameters

name: fun

desc: The function or method that arguments are bound to.

type: Func|BoundFunc|string

name: arguments

desc: The arguments that will be passed to the GridGUI.BoundFunc.function when it is called. If the function is a method then the class instance is passed as the first variadic arg.

type: any

meta: [variadic]

return value

desc: A new GridGUI.BoundFunc instance.

type: GridGUI.BoundFunc

ToStr

ToStr(indent := "")

Converts the object to a string.

parameters

name: indent

desc: The amount of indentation to add on each line.

type: string

default: ""

return value

desc: A string representing the bound function.

type: string

Back to top