Module Enumerations

GDNative enumerations, all accessible globally.

Tables

CallError Enum godot_variant_call_error, mapping UPPER_CASED names to ordinal values and vice-versa.
Error Enum godot_error, mapping UPPER_CASED names to ordinal values and vice-versa.
PropertyHint Enum godot_property_hint, mapping UPPER_CASED names to ordinal values and vice-versa.
PropertyUsage Enum godot_property_usage_flags, mapping UPPER_CASED names to ordinal values and vice-versa.
RPCMode Enum godot_method_rpc_mode, mapping UPPER_CASED names to ordinal values and vice-versa.
VariantType Enum godot_variant_type, mapping PascalCased names to ordinal value and vice-versa.


Tables

CallError

Enum godot_variant_call_error, mapping UPPER_CASED names to ordinal values and vice-versa.

 assert(CallError.OK == GODOT_CALL_ERROR_CALL_OK and CallError[CallError.OK] == 'OK')
 ...

Fields:

  • OK Ok
  • ERROR_INVALID_METHOD Invalid Method
  • ERROR_INVALID_ARGUMENT Invalid Argument
  • ERROR_TOO_MANY_ARGUMENTS Too Many Arguments
  • ERROR_TOO_FEW_ARGUMENTS Too Few Arguments
  • ERROR_INSTANCE_IS_NULL Instance Is Null
Error

Enum godot_error, mapping UPPER_CASED names to ordinal values and vice-versa.

 assert(Error.OK == GODOT_OK and Error[Error.OK] == 'OK')
 ...

Fields:

  • OK Ok
  • FAILED Failed
  • UNAVAILABLE Unavailable
  • UNCONFIGURED Unconfigured
  • UNAUTHORIZED Unauthorized
  • PARAMETER_RANGE_ERROR Parameter Range Error
  • OUT_OF_MEMORY Out Of Memory
  • FILE_NOT_FOUND File Not Found
  • FILE_BAD_DRIVE File Bad Drive
  • FILE_BAD_PATH File Bad Path
  • FILE_NO_PERMISSION File No Permission
  • FILE_ALREADY_IN_USE File Already In Use
  • FILE_CANT_OPEN File Can't Open
  • FILE_CANT_WRITE File Can't Write
  • FILE_CANT_READ File Can't Read
  • FILE_UNRECOGNIZED File Unrecognized
  • FILE_CORRUPT File Corrupt
  • FILE_MISSING_DEPENDENCIES File Missing Dependencies
  • FILE_EOF File EOF
  • CANT_OPEN Can't Open
  • CANT_CREATE Can't Create
  • QUERY_FAILED Query Failed
  • ALREADY_IN_USE Already In Use
  • LOCKED Locked
  • TIMEOUT Timeout
  • CANT_CONNECT Can't Connect
  • CANT_RESOLVE Can't Resolve
  • CONNECTION_ERROR Connection Error
  • CANT_ACQUIRE_RESOURCE Can't Acquire Resource
  • CANT_FORK Can't Fork
  • INVALID_DATA Invalid Data
  • INVALID_PARAMETER Invalid Parameter
  • ALREADY_EXISTS Already Exists
  • DOES_NOT_EXIST Does Not Exist
  • DATABASE_CANT_READ Database Cant Read
  • DATABASE_CANT_WRITE Database Cant Write
  • COMPILATION_FAILED Compilation Failed
  • METHOD_NOT_FOUND Method Not Found
  • LINK_FAILED Link Failed
  • SCRIPT_FAILED Script Failed
  • CYCLIC_LINK Cyclic Link
  • INVALID_DECLARATION Invalid Declaration
  • DUPLICATE_SYMBOL Duplicate Symbol
  • PARSE_ERROR Parse Error
  • BUSY Busy
  • SKIP Skip
  • HELP Help
  • BUG Bug
  • PRINTER_ON_FIRE Printer On Fire
PropertyHint

Enum godot_property_hint, mapping UPPER_CASED names to ordinal values and vice-versa.

 assert(PropertyHint.NONE == GODOT_PROPERTY_HINT_NONE and PropertyHint[PropertyHint.NONE] == 'NONE')
 ...

Fields:

  • NONE None
  • RANGE Range (hint_string = "min,max,step,slider"; step and slider are optional)
  • EXP_RANGE Exp Range (hint_string = "min,max,step"; exponential edit)
  • ENUM Enum (hint_string = "val1,val2,val3,etc")
  • EXP_EASING Exp Easing
  • LENGTH Length (hint_string = "length"; as integer)
  • SPRITE_FRAME Sprite Frame (Obsolete)
  • KEY_ACCEL Key Accel (hint_string = "length"; as integer)
  • FLAGS Flags (hint_string = "flag1,flag2,etc"; as bit flags)
  • LAYERS_2D_RENDER Layers 2D Render
  • LAYERS_2D_PHYSICS Layers 2D Physics
  • LAYERS_3D_RENDER Layers 3D Render
  • LAYERS_3D_PHYSICS Layers 3D Physics
  • FILE File (optional hint_string: file filter, e.g. "*.png,*.wav")
  • DIR Dir
  • GLOBAL_FILE Global File
  • GLOBAL_DIR Global Dir
  • RESOURCE_TYPE Resource Type
  • MULTILINE_TEXT Multiline Text
  • PLACEHOLDER_TEXT Placeholder Text
  • COLOR_NO_ALPHA Color No Alpha
  • IMAGE_COMPRESS_LOSSY Image Compress Lossy
  • IMAGE_COMPRESS_LOSSLESS Image Compress Lossless
  • OBJECT_ID Object Id
  • TYPE_STRING Type String (hint_string = "base class name")
  • NODE_PATH_TO_EDITED_NODE Node Path To Edited Node
  • METHOD_OF_VARIANT_TYPE Method Of Variant Type
  • METHOD_OF_BASE_TYPE Method Of Base Type
  • METHOD_OF_INSTANCE Method Of Instance
  • METHOD_OF_SCRIPT Method Of Script
  • PROPERTY_OF_VARIANT_TYPE Property Of Variant Type
  • PROPERTY_OF_BASE_TYPE Property Of Base Type
  • PROPERTY_OF_INSTANCE Property Of Instance
  • PROPERTY_OF_SCRIPT Property Of Script
PropertyUsage

Enum godot_property_usage_flags, mapping UPPER_CASED names to ordinal values and vice-versa.

 assert(PropertyUsage.STORAGE == GODOT_PROPERTY_USAGE_STORAGE and PropertyUsage[PropertyUsage.STORAGE] == 'STORAGE')
 ...

Fields:

  • STORAGE Storage
  • EDITOR Editor
  • NETWORK Network
  • EDITOR_HELPER Editor Helper
  • CHECKABLE Checkable
  • CHECKED Checked
  • INTERNATIONALIZED Internationalized
  • GROUP Group
  • CATEGORY Category
  • STORE_IF_NONZERO Store If Nonzero (Obsolete)
  • STORE_IF_NONONE Store If Nonone (Obsolete)
  • NO_INSTANCE_STATE No Instance State
  • RESTART_IF_CHANGED Restart If Changed
  • SCRIPT_VARIABLE Script Variable
  • STORE_IF_NULL Store If Null
  • ANIMATE_AS_TRIGGER Animate As Trigger
  • UPDATE_ALL_IF_MODIFIED Update All If Modified
  • DEFAULT Default
  • DEFAULT_INTL Default Internationalized
  • NOEDITOR No Editor
RPCMode

Enum godot_method_rpc_mode, mapping UPPER_CASED names to ordinal values and vice-versa.

 assert(RPCMode.DISABLED == GODOT_METHOD_RPC_MODE_DISABLED and RPCMode[RPCMode.DISABLED] == 'DISABLED')
 ...

Fields:

  • DISABLED RPC Disabled
  • REMOTE RPC Remote
  • MASTER RPC Master
  • PUPPET RPC Puppet
  • SLAVE RPC Slave
  • REMOTESYNC RPC Remotesync
  • SYNC RPC Sync
  • MASTERSYNC RPC Mastersync
  • PUPPETSYNC RPC Puppetsync
VariantType

Enum godot_variant_type, mapping PascalCased names to ordinal value and vice-versa.

 assert(VariantType.Nil == GODOT_VARIANT_TYPE_NIL and VariantType[VariantType.Nil] == 'Nil')
 ...

Fields:

  • Nil Nil
  • Bool Bool
  • Int Int
  • Real Real
  • String String
  • Vector2 Vector2
  • Rect2 Rect2
  • Vector3 Vector3
  • Transform2D Transform2D
  • Plane Plane
  • Quat Quat
  • AABB AABB
  • Basis Basis
  • Transform Transform
  • Color Color
  • NodePath NodePath
  • RID RID
  • Object Object
  • Dictionary Dictionary
  • Array Array
  • PoolByteArray PoolByteArray
  • PoolIntArray PoolIntArray
  • PoolRealArray PoolRealArray
  • PoolStringArray PoolStringArray
  • PoolVector2Array PoolVector2Array
  • PoolVector3Array PoolVector3Array
  • PoolColorArray PoolColorArray
generated by LDoc 1.4.6 Last updated 2023-01-04 08:52:34