CharacterBody2D PlatformOnLeaveEnum

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.CharacterBody2D.PlatformOnLeaveEnum
Namespace	Electron2D
Kind	enum
Category	Physics

Overview

Identifies how platform velocity should be applied when leaving a platform.

Syntax

public enum Electron2D.CharacterBody2D.PlatformOnLeaveEnum : System.IComparable, System.IConvertible, System.IFormattable, System.ISpanFormattable

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: CharacterBody2D.PlatformOnLeave

Platform leave policy values reserved for the kinematic movement API.

Remarks

The 0.1.0 Preview baseline exposes this policy as part of the public movement contract. Complex leave behavior is reserved for a later solver pass.

Since

This enum is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.CharacterBody2D.PlatformOnLeave

Members

Member	Kind	Summary
AddUpwardVelocity	Enum value	Add upward platform velocity while ignoring downward platform velocity.
AddVelocity	Enum value	Add the last platform velocity on leave.
DoNothing	Enum value	Do not add platform velocity on leave.

Member Details

AddUpwardVelocity

Kind: Enum value

public const Electron2D.CharacterBody2D.PlatformOnLeaveEnum AddUpwardVelocity

Summary

Add upward platform velocity while ignoring downward platform velocity.

Remarks

This policy is intended for moving platforms that should not pull the character downward after contact ends.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.CharacterBody2D.PlatformOnLeaveEnum

AddVelocity

Kind: Enum value

public const Electron2D.CharacterBody2D.PlatformOnLeaveEnum AddVelocity

Summary

Add the last platform velocity on leave.

Remarks

This is the default policy.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.CharacterBody2D.PlatformOnLeaveEnum

DoNothing

Kind: Enum value

public const Electron2D.CharacterBody2D.PlatformOnLeaveEnum DoNothing

Summary

Do not add platform velocity on leave.

Remarks

Use this policy when platform velocity should only be reported through Electron2D.CharacterBody2D.GetPlatformVelocity.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.CharacterBody2D.PlatformOnLeaveEnum