API Reference

API Reference

Generated public API reference for the Electron2D runtime assembly.

Type Index

Electron2D

Type	Kind	Summary
Electron2D.AnimatedSprite2D	class	Displays and advances a texture-frame animation from a Electron2D.AnimatedSprite2D.SpriteFrames resource.
Electron2D.Animation	class	Stores keyframed value and method-call tracks for Electron2D.AnimationPlayer.
Electron2D.Animation.InterpolationTypeEnum	enum	Describes how value tracks produce values between neighboring keys.
Electron2D.Animation.LoopModeEnum	enum	Describes how playback behaves when it reaches the end of the resource.
Electron2D.Animation.TrackTypeEnum	enum	Describes the supported animation track kinds.
Electron2D.AnimationLibrary	class	Stores named Electron2D.Animation resources for Electron2D.AnimationPlayer.
Electron2D.AnimationPlayer	class	Plays Electron2D.Animation resources against nodes in the scene tree.
Electron2D.Area2D	class	Provides an Electron2D 2D area node for overlap and influence queries.
Electron2D.AtlasTexture	class	Provides an Electron2D texture that draws a region of another Electron2D.Texture2D.
Electron2D.Callable	struct	Represents the callable value type.
Electron2D.CallbackTweener	class	Calls a Electron2D.Callable when a tween sequence reaches this step.
Electron2D.Camera2D	class	Provides the Electron2D 2D camera node for selecting the visible canvas region.
Electron2D.CanvasItem	class	Provides the Electron2D base node for items that can be drawn on a 2D canvas.
Electron2D.CanvasLayer	class	Provides an Electron2D node that renders 2D descendants on an independent canvas layer.
Electron2D.CapsuleShape2D	class	Provides a capsule-shaped 2D physics resource.
Electron2D.CharacterBody2D	class	Provides a 2D character body moved directly by user code.
Electron2D.CharacterBody2D.MotionModeEnum	enum	Identifies how collisions are classified during slide movement.
Electron2D.CharacterBody2D.PlatformOnLeaveEnum	enum	Identifies how platform velocity should be applied when leaving a platform.
Electron2D.CircleShape2D	class	Provides a circular 2D physics shape resource.
Electron2D.CollisionObject2D	class	Provides the Electron2D base node for 2D objects that own a physics server RID.
Electron2D.CollisionShape2D	class	Provides a node that attaches a Electron2D.Shape2D to a collision object.
Electron2D.Color	struct	Represents the color value type.
Electron2D.ConcavePolygonShape2D	class	Provides a concave polygon 2D physics shape resource backed by line segments.
Electron2D.ConnectFlags	enum	Identifies values used by the connect flags API.
Electron2D.Control	class	Provides the Electron2D base node for 2D user interface controls.
Electron2D.ConvexPolygonShape2D	class	Provides a convex polygon 2D physics shape resource.
Electron2D.DisplayServer	class	Provides display, orientation and virtual keyboard state.
Electron2D.DisplayServer.ScreenOrientation	enum	Identifies a requested screen orientation.
Electron2D.DisplayServer.VirtualKeyboardType	enum	Identifies the requested virtual keyboard layout.
Electron2D.Error	enum	Identifies values used by the error API.
Electron2D.ExportAttribute	class	Marks a script field or property as an exported value that can be serialized and shown by editor tooling.
Electron2D.Font	class	Provides the Electron2D base resource for text layout and drawing.
Electron2D.HorizontalAlignment	enum	Defines horizontal text alignment values used by Electron2D text drawing APIs.
Electron2D.Input	class	Provides process-wide action input state.
Electron2D.InputEvent	class	Base class for Electron2D input events delivered to Electron2D.Node._Input(Electron2D.InputEvent).
Electron2D.InputEventAction	class	Represents a direct action input event.
Electron2D.InputEventFromWindow	class	Base class for input events that originate from a platform window.
Electron2D.InputEventJoypadButton	class	Represents a gamepad button press or release.
Electron2D.InputEventJoypadMotion	class	Represents a gamepad axis motion event.
Electron2D.InputEventKey	class	Represents a keyboard key press, release, echo, or text input scalar value.
Electron2D.InputEventMouse	class	Base class for mouse input events.
Electron2D.InputEventMouseButton	class	Represents a mouse button press, release, or wheel step.
Electron2D.InputEventMouseMotion	class	Represents a mouse movement event.
Electron2D.InputEventScreenDrag	class	Represents a screen touch drag event.
Electron2D.InputEventScreenTouch	class	Represents a screen touch press, release or cancel event.
Electron2D.InputEventWithModifiers	class	Base class for input events that carry keyboard modifier state.
Electron2D.InputMap	class	Stores input actions and their input event bindings.
Electron2D.IntervalTweener	class	Consumes time inside a tween sequence without changing objects.
Electron2D.JoyAxis	enum	Identifies a normalized gamepad axis.
Electron2D.JoyButton	enum	Identifies a standardized gamepad button.
Electron2D.Key	enum	Identifies a keyboard key in the Electron2D input event model.
Electron2D.KeyLocation	enum	Identifies the left or right location of a keyboard key.
Electron2D.KinematicCollision2D	class	Holds collision data returned by 2D body movement methods.
Electron2D.Label	class	Provides the Electron2D control for drawing a single line of plain text.
Electron2D.Material	class	Provides the Electron2D base resource for visual materials.
Electron2D.Mathf	class	Represents the mathf type.
Electron2D.MouseButton	enum	Identifies a mouse button or mouse wheel direction in the Electron2D input model.
Electron2D.MouseButtonMask	enum	Provides bit flags for mouse buttons held during a mouse event.
Electron2D.Node	class	Represents the node type.
Electron2D.Node2D	class	Provides the Electron2D 2D transform node used by sprites and future 2D nodes.
Electron2D.NodePath	struct	Represents the node path value type.
Electron2D.Object	class	Represents the object type.
Electron2D.PackedScene	class	Represents the packed scene type.
Electron2D.PhysicsBody2D	class	Provides the base node for physical 2D bodies that participate in collision queries.
Electron2D.PhysicsDirectSpaceState2D	class	Provides direct 2D physics queries for a Electron2D.World2D.
Electron2D.PhysicsMaterial	class	Provides an Electron2D physics material resource for 2D body collision behavior.
Electron2D.PhysicsPointQueryParameters2D	class	Stores parameters for Electron2D.PhysicsDirectSpaceState2D.IntersectPoint(Electron2D.PhysicsPointQueryParameters2D,System.Int32).
Electron2D.PhysicsRayQueryParameters2D	class	Stores parameters for Electron2D.PhysicsDirectSpaceState2D.IntersectRay(Electron2D.PhysicsRayQueryParameters2D).
Electron2D.PhysicsServer2D	class	Provides the Electron2D server boundary for low-level 2D physics objects.
Electron2D.PhysicsServer2D.ProcessInfo	enum	Identifies a physics process statistic that can be queried from the server.
Electron2D.PhysicsServer2D.ShapeType	enum	Identifies the shape resource kind stored by the physics server.
Electron2D.PhysicsServer2D.SpaceParameter	enum	Identifies a configurable parameter of a physics space.
Electron2D.PhysicsShapeQueryParameters2D	class	Stores parameters for Electron2D.PhysicsDirectSpaceState2D.IntersectShape(Electron2D.PhysicsShapeQueryParameters2D,System.Int32).
Electron2D.PropertyTweener	class	Tweens a public property or field on an object.
Electron2D.RandomNumberGenerator	class	Represents the random number generator type.
Electron2D.RayCast2D	class	Provides an Electron2D 2D raycast node.
Electron2D.Rect2	struct	Represents the rect2 value type.
Electron2D.Rect2I	struct	Represents the rect2 i value type.
Electron2D.RectangleShape2D	class	Provides a rectangular 2D physics shape resource.
Electron2D.RefCounted	class	Represents the ref counted type.
Electron2D.RenderingServer	class	Provides the Electron2D server boundary for rendering capabilities.
Electron2D.RenderingServer.RenderingFeature	enum	Identifies a renderer feature that can be queried at runtime.
Electron2D.RenderingServer.RenderingProfile	enum	Identifies the active renderer profile.
Electron2D.Resource	class	Represents the resource type.
Electron2D.ResourceUid	class	Manages stable unique identifiers for resource paths in an Electron2D project.
Electron2D.Rid	struct	Represents the rid value type.
Electron2D.RigidBody2D	class	Provides an Electron2D rigid 2D physics body.
Electron2D.RigidBody2D.CenterOfMassModeEnum	enum	Identifies how the body's center of mass should be selected.
Electron2D.RigidBody2D.FreezeModeEnum	enum	Identifies how a frozen rigid body should interact with the simulation.
Electron2D.SceneTree	class	Represents the scene tree type.
Electron2D.SegmentShape2D	class	Provides a finite line segment 2D physics shape resource.
Electron2D.Shader	class	Provides the Electron2D resource for a canvas shader source.
Electron2D.Shader.Mode	enum	Identifies the shader mode.
Electron2D.ShaderMaterial	class	Provides the Electron2D material resource backed by a custom Electron2D.ShaderMaterial.Shader.
Electron2D.Shape2D	class	Provides the Electron2D base resource for 2D physics shapes.
Electron2D.SignalAttribute	class	Marks a script delegate declaration as a signal that can be registered on an Electron2D object and emitted through Electron2D.Object.EmitSignal(System.String,System.Object[]).
Electron2D.Sprite2D	class	Provides a node that submits a 2D texture for drawing.
Electron2D.SpriteFrames	class	Stores named texture-frame animations for Electron2D.AnimatedSprite2D.
Electron2D.SpriteFrames.LoopModeEnum	enum	Describes how an animation loops at its boundaries.
Electron2D.StaticBody2D	class	Provides an Electron2D static 2D physics body.
Electron2D.StringName	struct	Represents the string name value type.
Electron2D.Texture2D	class	Provides the Electron2D base resource for 2D textures.
Electron2D.ToolAttribute	class	Marks a C# script class as capable of explicit editor-time execution.
Electron2D.Transform2D	struct	Represents the transform2 d value type.
Electron2D.Translation	class	Stores translated messages for one locale.
Electron2D.TranslationServer	class	Provides process-wide translation lookup and locale selection.
Electron2D.Tween	class	Runs sequential property, interval and callback animation steps.
Electron2D.Tween.EaseType	enum	Lists how a transition curve is applied to normalized time.
Electron2D.Tween.TransitionType	enum	Lists transition curves available to tween interpolation.
Electron2D.Tweener	class	Represents one step in a Electron2D.Tween sequence.
Electron2D.Variant	struct	Stores one value from the closed Electron2D 0.1.0 Preview Variant type set.
Electron2D.Variant.Type	enum	Identifies the type currently stored in a Electron2D.Variant.
Electron2D.Vector2	struct	Represents the vector2 value type.
Electron2D.Vector2I	struct	Represents the vector2 i value type.
Electron2D.VerticalAlignment	enum	Identifies the vertical alignment used by controls that draw text.
Electron2D.Viewport	class	Provides the Electron2D viewport node for 2D camera selection and canvas transforms.
Electron2D.ViewportTexture	class	Provides an Electron2D dynamic texture for the contents of a Electron2D.Viewport.
Electron2D.World2D	class	Provides access to the 2D world associated with a canvas item.

Electron2D.Collections

Type	Kind	Summary
Electron2D.Collections.Array	class	Stores an ordered mutable list of Electron2D.Variant values.
Electron2D.Collections.Dictionary	class	Stores mutable key/value pairs where both keys and values are Electron2D.Variant.