Callable

Conformances

• protocol ContentVariantRepresentable

  Some of Godot’s builtin classes use ContentType for storage. This needs to be public because it affects their initialization, but SwiftGodot users should never need to conform their types toContentVariantRepresentable.

• protocol Copyable

  A type whose values can be implicitly or explicitly copied.

• protocol Equatable

  A type that can be compared for value equality.

• protocol Escapable
• protocol VariantRepresentable

  Types that conform to VariantRepresentable can be stored directly in Variant with no conversion. These include all of the Variant types from Godot (for example GString, Rect, Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.

• protocol VariantStorable

  Types that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.

Typealiases

• typealias ContentType

Type members

• init()

  Constructs an empty Callable, with no object nor method bound.

• init(@escaping (borrowing Arguments) -> Variant)

  Creates a Callable instance from a Swift function

• init(alreadyOwnedContent: ContentType)
• init(content: ContentType)
• init(from: Callable)

  Constructs a Callable as a copy of the given Callable.

• init(object: Object, method: StringName)

  Creates a new Callable for the method named method in the specified object.

• static var godotType: Variant.GType
• static let zero: ContentType
• static func create(variant: Variant, method: StringName) -> Callable

  Creates a new Callable for the method named method in the specified variant. To represent a method of a built-in Variant type, a custom callable is used (see isCustom). If variant is Object, then a standard callable will be created instead.

• static func != (lhs: Callable, rhs: Callable) -> Bool

  Returns true if both Callables invoke different targets.

• static func == (lhs: Callable, rhs: Callable) -> Bool

  Returns true if both Callables invoke the same custom target.

Instance members

• var content: ContentType
• func bind(Variant...) -> Callable

  Returns a copy of this Callable with one or more arguments bound. When called, the bound arguments are passed after the arguments supplied by call(). See also unbind(argcount:).

• func bindv(arguments: GArray) -> Callable

  Returns a copy of this Callable with one or more arguments bound, reading them from an array. When called, the bound arguments are passed after the arguments supplied by call(). See also unbind(argcount:).

• func call(Variant...) -> Variant

  Calls the method represented by this Callable. Arguments can be passed and should match the method’s signature.

• func callDeferred(Variant...)

  Calls the method represented by this Callable in deferred mode, i.e. at the end of the current frame. Arguments can be passed and should match the method’s signature.

• func callv(arguments: GArray) -> Variant

  Calls the method represented by this Callable. Unlike call(), this method expects all arguments to be contained inside the arguments GArray.

• func getArgumentCount() -> Int64

  Returns the total number of arguments this Callable should take, including optional arguments. This means that any arguments bound with bind() are subtracted from the result, and any arguments unbound with unbind(argcount:) are added to the result.

• func getBoundArguments() -> GArray

  Return the bound arguments (as long as getBoundArgumentsCount is greater than zero), or empty (if getBoundArgumentsCount is less than or equal to zero).

• func getBoundArgumentsCount() -> Int64

  Returns the total amount of arguments bound (or unbound) via successive bind() or unbind(argcount:) calls. If the amount of arguments unbound is greater than the ones bound, this function returns a value less than zero.

• func getMethod() -> StringName

  Returns the name of the method represented by this Callable. If the callable is a GDScript lambda function, returns the function’s name or "<anonymous lambda>".

• func getObjectId() -> Int64

  Returns the ID of this Callable’s object (see getInstanceId).

• func hash() -> Int64

  Returns the 32-bit hash value of this Callable’s object.

• func isCustom() -> Bool

  Returns true if this Callable is a custom callable. Custom callables are used:

• func isNull() -> Bool

  Returns true if this Callable has no target to call the method on.

• func isStandard() -> Bool

  Returns true if this Callable is a standard callable. This method is the opposite of isCustom. Returns false if this callable is a lambda function.

• func isValid() -> Bool

  Returns true if the callable’s object exists and has a valid method name assigned, or is a custom callable.

• func rpc(Variant...)

  Perform an RPC (Remote Procedure Call) on all connected peers. This is used for multiplayer and is normally not available, unless the function being called has been marked as RPC (using [annotation @GDScript.@rpc] or rpcConfig(method:config:)). Calling this method on unsupported functions will result in an error. See Node/rpc(method:).

• func rpcId(peerId: Int64, Variant...)

  Perform an RPC (Remote Procedure Call) on a specific peer ID (see multiplayer documentation for reference). This is used for multiplayer and is normally not available unless the function being called has been marked as RPC (using [annotation @GDScript.@rpc] or rpcConfig(method:config:)). Calling this method on unsupported functions will result in an error. See Node/rpcId(peerId:method:).

• func unbind(argcount: Int64) -> Callable

  Returns a copy of this Callable with a number of arguments unbound. In other words, when the new callable is called the last few arguments supplied by the user are ignored, according to argcount. The remaining arguments are passed to the callable. This allows to use the original callable in a context that attempts to pass more arguments than this callable can handle, e.g. a signal with a fixed number of arguments. See also bind().

Type features

• init?(Variant)
• static func makeOrUnwrap(Variant) -> Self?

  Unwraps an object from a variant.

• static func makeOrUnwrap(Variant) -> Self?

  Unwraps an object from a variant. This is useful when you want one method to call that will return the unwrapped Variant, regardless of whether it is a SwiftGodot.Object or not.

• static func != (lhs: Self, rhs: Self) -> Bool

  Returns a Boolean value indicating whether two values are not equal.

Instance features

• func toVariantRepresentable() -> Self