Expression
A class that stores an expression you can execute.
Expression.swift:22class Expression
An expression can be made of any arithmetic operation, built-in math function call, method call of a passed instance, or built-in type construction call.
An example expression text using the built-in math functions could be sqrt(pow(3, 2) + pow(4, 2))
.
In the following example we use a LineEdit
node to write our expression and show the result.
Superclasses
class RefCounted
Base class for reference-counted objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertible
A type with a customized textual representation.
protocol Equatable
A type that can be compared for value equality.
protocol Hashable
A type that can be hashed into a
Hasher
to produce an integer hash value.protocol Identifiable<ID>
A class of types whose instances hold the value of an entity with stable identity.
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 exampleGString
,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.
Type members
Instance members
func execute(inputs: GArray, baseInstance: Object?, showError: Bool, constCallsOnly: Bool
) -> Variant Executes the expression that was previously parsed by
parse(expression:inputNames:)
and returns the result. Before you use the returned object, you should check if the method failed by callinghasExecuteFailed
.func getErrorText(
) -> String Returns the error text if
parse(expression:inputNames:)
orexecute(inputs:baseInstance:showError:constCallsOnly:)
has failed.func hasExecuteFailed(
) -> Bool Returns
true
ifexecute(inputs:baseInstance:showError:constCallsOnly:)
has failed.func parse(expression: String, inputNames: PackedStringArray
) -> GodotError Parses the expression and returns an
GodotError
code.