GD

Type members

• static func abs(x: Variant) -> Variant

  Returns the absolute value of a Variant parameter x (i.e. non-negative value). Supported types: integer, float, Vector2, Vector2i, Vector3, Vector3i, Vector4, Vector4i.

• static func angleDifference(from: Double, to: Double) -> Double

  Returns the difference between the two angles, in the range of [-PI, +PI]. When from and to are opposite, returns -PI if from is smaller than to, or PI otherwise.

• static func bezierDerivative(start: Double, control1: Double, control2: Double, end: Double, t: Double) -> Double

  Returns the derivative at the given t on a one-dimensional Bézier curve defined by the given control1, control2, and end points.

• static func bezierInterpolate(start: Double, control1: Double, control2: Double, end: Double, t: Double) -> Double

  Returns the point at the given t on a one-dimensional Bézier curve defined by the given control1, control2, and end points.

• static func bytesToVar(bytes: PackedByteArray) -> Variant

  Decodes a byte array back to a Variant value, without decoding objects.

• static func bytesToVarWithObjects(bytes: PackedByteArray) -> Variant

  Decodes a byte array back to a Variant value. Decoding objects is allowed.

• static func clamp(value: Variant, min: Variant, max: Variant) -> Variant

  Clamps the value, returning a Variant not less than min and not more than max. Any values that can be compared with the less than and greater than operators will work.

• static func clampf(value: Double, min: Double, max: Double) -> Double

  Clamps the value, returning a float not less than min and not more than max.

• static func clampi(value: Int64, min: Int64, max: Int64) -> Int64

  Clamps the value, returning an integer not less than min and not more than max.

• static func cubicInterpolate(from: Double, to: Double, pre: Double, post: Double, weight: Double) -> Double

  Cubic interpolates between two values by the factor defined in weight with pre and post values.

• static func cubicInterpolateAngle(from: Double, to: Double, pre: Double, post: Double, weight: Double) -> Double

  Cubic interpolates between two rotation values with shortest path by the factor defined in weight with pre and post values. See also lerpAngle().

• static func cubicInterpolateAngleInTime(from: Double, to: Double, pre: Double, post: Double, weight: Double, toT: Double, preT: Double, postT: Double) -> Double

  Cubic interpolates between two rotation values with shortest path by the factor defined in weight with pre and post values. See also lerpAngle().

• static func cubicInterpolateInTime(from: Double, to: Double, pre: Double, post: Double, weight: Double, toT: Double, preT: Double, postT: Double) -> Double

  Cubic interpolates between two values by the factor defined in weight with pre and post values.

• static func dbToLinear(db: Double) -> Double

  Converts from decibels to linear energy (audio).

• static func ease(x: Double, curve: Double) -> Double

  Returns an “eased” value of x based on an easing function defined with curve. This easing function is based on an exponent. The curve can be any floating-point number, with specific values leading to the following behaviors:

• static func errorString(error: Int64) -> String

  Returns a human-readable name for the given GodotError code.

• static func hash(variable: Variant) -> Int64

  Returns the integer hash of the passed variable.

• static func instanceFromId(instanceId: Int64) -> Object?

  Returns the Object that corresponds to instanceId. All Objects have a unique instance ID. See also getInstanceId.

• static func isEqualApprox(a: Double, b: Double) -> Bool

  Returns true if a and b are approximately equal to each other.

• static func isFinite(x: Double) -> Bool

  Returns whether x is a finite value, i.e. it is not @GDScript.NAN, positive infinity, or negative infinity.

• static func isInf(x: Double) -> Bool

  Returns true if x is either positive infinity or negative infinity.

• static func isInstanceIdValid(id: Int64) -> Bool

  Returns true if the Object that corresponds to id is a valid object (e.g. has not been deleted from memory). All Objects have a unique instance ID.

• static func isInstanceValid(instance: Variant) -> Bool

  Returns true if instance is a valid Object (e.g. has not been deleted from memory).

• static func isNan(x: Double) -> Bool

  Returns true if x is a NaN (“Not a Number” or invalid) value.

• static func isSame(a: Variant, b: Variant) -> Bool

  Returns true, for value types, if a and b share the same value. Returns true, for reference types, if the references of a and b are the same.

• static func isZeroApprox(x: Double) -> Bool

  Returns true if x is zero or almost zero. The comparison is done using a tolerance calculation with a small internal epsilon.

• static func lerpAngle(from: Double, to: Double, weight: Double) -> Double

  Linearly interpolates between two angles (in radians) by a weight value between 0.0 and 1.0.

• static func linearToDb(lin: Double) -> Double

  Converts from linear energy to decibels (audio). This can be used to implement volume sliders that behave as expected (since volume isn’t linear).

• static func load(path: String) -> Resource?

  Loads a resource from the filesystem located at path.

• static func load<T>(path: String) -> T?

  Loads a resource from the filesystem located at path.

• static func max(arg1: Variant, arg2: Variant, Variant...) -> Variant

  Returns the maximum of the given numeric values. This function can take any number of arguments.

• static func maxf(a: Double, b: Double) -> Double

  Returns the maximum of two float values.

• static func maxi(a: Int64, b: Int64) -> Int64

  Returns the maximum of two integer values.

• static func min(arg1: Variant, arg2: Variant, Variant...) -> Variant

  Returns the minimum of the given numeric values. This function can take any number of arguments.

• static func minf(a: Double, b: Double) -> Double

  Returns the minimum of two float values.

• static func mini(a: Int64, b: Int64) -> Int64

  Returns the minimum of two integer values.

• static func moveToward(from: Double, to: Double, delta: Double) -> Double

  Moves from toward to by the delta amount. Will not go past to.

• static func nearestPo2(value: Int64) -> Int64

  Returns the smallest integer power of 2 that is greater than or equal to value.

• static func pingpong(value: Double, length: Double) -> Double

  Wraps value between 0 and the length. If the limit is reached, the next value the function returns is decreased to the 0 side or increased to the length side (like a triangle wave). If length is less than zero, it becomes positive.

• static func print(Any..., separator: String)

  Converts one or more arguments of any type to string in the best way possible and prints them to the console.

• static func print(arg1: Variant, Variant...)

  Converts one or more arguments of any type to string in the best way possible and prints them to the console.

• static func printDebug(Any..., separator: String, fileID: StaticString, function: StaticString, line: UInt)

  Converts one or more arguments of any type to string in the best way possible and prints them to the console, with fileID, line, and function name of the calling function.

• static func printErr(Any..., separator: String)

  Converts one or more arguments of any type to string in the best way possible and prints them to the console.

• static func printRich(Any..., separator: String)

  Converts one or more arguments of any type to string in the best way possible and prints them to the console.

• static func printRich(arg1: Variant, Variant...)

  Converts one or more arguments of any type to string in the best way possible and prints them to the console.

• static func printVerbose(arg1: Variant, Variant...)

  If verbose mode is enabled (isStdoutVerbose returning true), converts one or more arguments of any type to string in the best way possible and prints them to the console.

• static func printerr(arg1: Variant, Variant...)

  Prints one or more arguments to strings in the best way possible to standard error line.

• static func printraw(arg1: Variant, Variant...)

  Prints one or more arguments to strings in the best way possible to the OS terminal. Unlike print(), no newline is automatically added at the end.

• static func prints(arg1: Variant, Variant...)

  Prints one or more arguments to the console with a space between each argument.

• static func printt(arg1: Variant, Variant...)

  Prints one or more arguments to the console with a tab between each argument.

• static func pushError(Any..., separator: String)

  Pushes an error message to Godot’s built-in debugger and to the OS terminal.

• static func pushError(arg1: Variant, Variant...)

  Pushes an error message to Godot’s built-in debugger and to the OS terminal.

• static func pushWarning(Any..., separator: String)

  Pushes a warning message to Godot’s built-in debugger and to the OS terminal.

• static func pushWarning(arg1: Variant, Variant...)

  Pushes a warning message to Godot’s built-in debugger and to the OS terminal.

• static func randFromSeed(Int64) -> PackedInt64Array

  Given a seed, returns a PackedInt64Array of size 2, where its first element is the randomized integer value, and the second element is the same as seed. Passing the same seed consistently returns the same array.

• static func randf() -> Double

  Returns a random floating-point value between 0.0 and 1.0 (inclusive).

• static func randfRange(from: Double, to: Double) -> Double

  Returns a random floating-point value between from and to (inclusive).

• static func randfn(mean: Double, deviation: Double) -> Double

  Returns a normally-distributed, pseudo-random floating-point value from the specified mean and a standard deviation. This is also known as a Gaussian distribution.

• static func randi() -> Int64

  Returns a random unsigned 32-bit integer. Use remainder to obtain a random value in the interval [0, N - 1] (where N is smaller than 2^32).

• static func randiRange(from: Int64, to: Int64) -> Int64

  Returns a random signed 32-bit integer between from and to (inclusive). If to is lesser than from, they are swapped.

• static func randomize()

  Randomizes the seed (or the internal state) of the random number generator. The current implementation uses a number based on the device’s time.

• static func remap(value: Double, istart: Double, istop: Double, ostart: Double, ostop: Double) -> Double

  Maps a value from range [istart, istop] to [ostart, ostop]. See also lerp() and inverseLerp(). If value is outside [istart, istop], then the resulting value will also be outside [ostart, ostop]. If this is not desired, use clamp() on the result of this function.

• static func ridAllocateId() -> Int64

  Allocates a unique ID which can be used by the implementation to construct an RID. This is used mainly from native extensions to implement servers.

• static func ridFromInt64(base: Int64) -> RID

  Creates an RID from a base. This is used mainly from native extensions to build servers.

• static func rotateToward(from: Double, to: Double, delta: Double) -> Double

  Rotates from toward to by the delta amount. Will not go past to.

• static func seed(base: Int64)

  Sets the seed for the random number generator to base. Setting the seed manually can ensure consistent, repeatable results for most random functions.

• static func sign(x: Variant) -> Variant

  Returns the same type of Variant as x, with -1 for negative values, 1 for positive values, and 0 for zeros. For nan values it returns 0.

• static func signf(x: Double) -> Double

  Returns -1.0 if x is negative, 1.0 if x is positive, and 0.0 if x is zero. For nan values of x it returns 0.0.

• static func signi(x: Int64) -> Int64

  Returns -1 if x is negative, 1 if x is positive, and 0 if if x is zero.

• static func sinh(x: Double) -> Double

  Returns the hyperbolic sine of x.

• static func smoothstep(from: Double, to: Double, x: Double) -> Double

  Returns the result of smoothly interpolating the value of x between 0 and 1, based on the where x lies with respect to the edges from and to.

• static func snappedi(x: Double, step: Int64) -> Int64

  Returns the multiple of step that is the closest to x.

• static func stepDecimals(x: Double) -> Int64

  Returns the position of the first non-zero digit, after the decimal point. Note that the maximum return value is 10, which is a design decision in the implementation.

• static func str(arg1: Variant, Variant...) -> String

  Converts one or more arguments of any Variant type to a String in the best way possible.

• static func strToVar(string: String) -> Variant

  Converts a formatted string that was returned by varToStr() to the original Variant.

• static func typeConvert(variant: Variant, type: Int64) -> Variant

  Converts the given variant to the given type, using the Variant.GType values. This method is generous with how it handles types, it can automatically convert between array types, convert numeric Strings to integer, and converting most things to String.

• static func typeString(type: Int64) -> String

  Returns a human-readable name of the given type, using the Variant.GType values.

• static func typeof(variable: Variant) -> Int64

  Returns the internal type of the given variable, using the Variant.GType values.

• static func varToBytes(variable: Variant) -> PackedByteArray

  Encodes a Variant value to a byte array, without encoding objects. Deserialization can be done with bytesToVar().

• static func varToBytesWithObjects(variable: Variant) -> PackedByteArray

  Encodes a Variant value to a byte array. Encoding objects is allowed (and can potentially include executable code). Deserialization can be done with bytesToVarWithObjects().

• static func varToStr(variable: Variant) -> String

  Converts a Variant variable to a formatted String that can then be parsed using strToVar().

• static func weakref(obj: Variant) -> Variant

  Returns a WeakRef instance holding a weak reference to obj. Returns an empty WeakRef instance if obj is null. Prints an error and returns null if obj is neither Object-derived nor null.

• static func wrap(value: Variant, min: Variant, max: Variant) -> Variant

  Wraps the Variant value between min and max. Can be used for creating loop-alike behavior or infinite surfaces.

• static func wrapf(value: Double, min: Double, max: Double) -> Double

  Wraps the float value between min and max. Can be used for creating loop-alike behavior or infinite surfaces.

• static func wrapi(value: Int64, min: Int64, max: Int64) -> Int64

  Wraps the integer value between min and max. Can be used for creating loop-alike behavior or infinite surfaces.