# CollisionHandlerGravity¶

from panda3d.core import CollisionHandlerGravity

class CollisionHandlerGravity

A specialized kind of CollisionHandler that sets the Z height of the collider to a fixed linear offset from the highest detected collision point each frame. It’s intended to implement walking around on a floor of varying height by casting a ray down from the avatar’s head.

Inheritance diagram

__init__()
addVelocity(velocity: float)None

Adds the sepcified amount to the current velocity. This is mostly here allow this common operation to be faster for scripting, but it’s also more concise even in cpp.

property airborne_heightfloat

Return the height of the object from the ground.

The object might not necessarily be at rest. Use isOnGround() if you want to know whether the object is on the ground and at rest.

property contact_normalLVector3
getAirborneHeight()float

Return the height of the object from the ground.

The object might not necessarily be at rest. Use isOnGround() if you want to know whether the object is on the ground and at rest.

static getClassType()TypeHandle
getContactNormal()LVector3
getGravity()float

Gets the linear gravity force (always plumb).

getImpactVelocity()float

How hard did the object hit the ground. This value is set on impact with the ground. You may want to watch (poll) on is_on_groun() and when that is true, call getImpactVelocity(). Normally I avoid polling, but we are calling isOnGround() frequently anyway.

getLegacyMode()bool

returns true if legacy mode is enabled

getMaxVelocity()float

Retrieves the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second. See setMaxVelocity().

getOffset()float

Returns the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider.

getReach()float

Returns the reach to add to (or subtract from) the highest collision point

getVelocity()float

Gets the current vertical velocity.

Generally, negative values mean the object is in free fall; while postive values mean the object has vertical thrust.

A zero value does not necessarily mean the object on the ground, it may also be weightless and/or at the apex of its jump.

See Also: isOnGround() and getGravity()

property gravityfloat
Getter

Gets the linear gravity force (always plumb).

Setter

Sets the linear gravity force (always plumb).

property impact_velocityfloat

How hard did the object hit the ground. This value is set on impact with the ground. You may want to watch (poll) on is_on_groun() and when that is true, call getImpactVelocity(). Normally I avoid polling, but we are calling isOnGround() frequently anyway.

isOnGround()bool

Is the object at rest?

property max_velocityfloat
Getter

Retrieves the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second. See setMaxVelocity().

Setter

Sets the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second. Set this to zero to allow it to instantly teleport any distance.

property offsetfloat
Getter

Returns the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider.

Setter

Sets the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider.

property on_groundbool

Is the object at rest?

property reachfloat
Getter

Returns the reach to add to (or subtract from) the highest collision point

Setter

Sets the reach to add to (or subtract from) the highest collision point

setGravity(gravity: float)None

Sets the linear gravity force (always plumb).

setLegacyMode(legacy_mode: bool)None

Enables old behavior required by Toontown (Sellbot Factory lava room is good test case, lava and conveyor belt specifically). Behavior is to throw enter/exit events only for floor that the toon is in contact with

setMaxVelocity(max_vel: float)None

Sets the maximum speed at which the object will be allowed to descend towards a floor below it, in units per second. Set this to zero to allow it to instantly teleport any distance.

setOffset(offset: float)None

Sets the linear offset to add to (or subtract from) the highest detected collision point to determine the actual height at which to set the collider.

setReach(reach: float)None

Sets the reach to add to (or subtract from) the highest collision point

setVelocity(velocity: float)None

Sets the current vertical velocity.

property velocityfloat
Getter

Gets the current vertical velocity.

Generally, negative values mean the object is in free fall; while postive values mean the object has vertical thrust.

A zero value does not necessarily mean the object on the ground, it may also be weightless and/or at the apex of its jump.

See Also: isOnGround() and getGravity()

Setter

Sets the current vertical velocity.