panda3d.core.CollisionHandlerEvent

class CollisionHandlerEvent

Bases: CollisionHandler

A specialized kind of CollisionHandler that throws an event for each collision detected. The event thrown may be based on the name of the moving object or the struck object, or both. The first parameter of the event will be a pointer to the CollisionEntry that triggered it.

Inheritance diagram

Inheritance diagram of CollisionHandlerEvent

__init__() → None

The default CollisionHandlerEvent will throw no events. Its pattern strings must first be set via a call to addInPattern() and/or addOutPattern().

__init__(param0: CollisionHandlerEvent) → None
addAgainPattern(again_pattern: str) → None

Adds the pattern string that indicates how the event names are generated when a collision between two particular nodes is still detected. This event is thrown each consecutive time a collision between two particular nodes is detected, starting with the second time.

In general, the in_pattern event is thrown on the first detection of a collision between two particular nodes. In subsequent passes, as long as a collision between those two nodes continues to be detected each frame, the again_pattern is thrown. The first frame in which the collision is no longer detected, the out_pattern event is thrown.

addInPattern(in_pattern: str) → None

Adds a pattern string to the list of events that will be generated in response to a collision. The pattern string describes how the event name will be composed. It is a string that may contain any of the following:

%fn - the name of the “from” object’s node %in - the name of the “into” object’s node %fs - ‘t’ if “from” is tangible, ‘i’ if intangible %is - ‘t’ if “into” is tangible, ‘i’ if intangible %ig - ‘c’ if the collision is into a CollisionNode, ‘g’ if it is a geom.

%(tag)fh - generate event only if “from” node has the indicated net tag. %(tag)fx - generate event only if “from” node does not have the indicated net tag. %(tag)ih - generate event only if “into” node has the indicated net tag. %(tag)ix - generate event only if “into” node does not have the indicated net tag. %(tag)ft - the indicated net tag value of the “from” node. %(tag)it - the indicated net tag value of the “into” node.

Parentheses in the above are literal and should be included in the actual pattern.

The event name will be based on the in_pattern string specified here, with all occurrences of the above strings replaced with the corresponding values.

In general, the in_pattern event is thrown on the first detection of a collision between two particular nodes. In subsequent passes, as long as a collision between those two nodes continues to be detected each frame, the again_pattern is thrown. The first frame in which the collision is no longer detected, the out_pattern event is thrown.

addOutPattern(out_pattern: str) → None

Adds the pattern string that indicates how the event names are generated when a collision between two particular nodes is no longer detected.

In general, the in_pattern event is thrown on the first detection of a collision between two particular nodes. In subsequent passes, as long as a collision between those two nodes continues to be detected each frame, the again_pattern is thrown. The first frame in which the collision is no longer detected, the out_pattern event is thrown.

property again_patterns

Returns the nth pattern string that indicates how the event names are generated for each collision detected. See addOutPattern().

Return type

Sequence[string]

clear() → None

Empties the list of elements that all colliders are known to be colliding with. No “out” events will be thrown; if the same collision is detected next frame, a new “in” event will be thrown for each collision.

This can be called each frame to defeat the persistent “in” event mechanism, which prevents the same “in” event from being thrown repeatedly. However, also see addAgainPattern(), which can be used to set the event that is thrown when a collision is detected for two or more consecutive frames.

clearAgainPatterns() → None

Removes all of the previously-added in patterns. See add_again_pattern.

clearInPatterns() → None

Removes all of the previously-added in patterns. See add_in_pattern.

clearOutPatterns() → None

Removes all of the previously-added in patterns. See add_out_pattern.

flush() → None

Same as clear() except “out” events are thrown.

getAgainPattern(n: int) → str

Returns the nth pattern string that indicates how the event names are generated for each collision detected. See addAgainPattern().

getAgainPatterns() → list
static getClassType() → TypeHandle
Return type

TypeHandle

getInPattern(n: int) → str

Returns the nth pattern string that indicates how the event names are generated for each collision detected. See addInPattern().

getInPatterns() → list
getNumAgainPatterns() → int

Returns the number of in pattern strings that have been added.

getNumInPatterns() → int

Returns the number of in pattern strings that have been added.

getNumOutPatterns() → int

Returns the number of in pattern strings that have been added.

getOutPattern(n: int) → str

Returns the nth pattern string that indicates how the event names are generated for each collision detected. See addOutPattern().

getOutPatterns() → list
property in_patterns

Returns the nth pattern string that indicates how the event names are generated for each collision detected. See addInPattern().

Return type

Sequence[string]

property out_patterns

Returns the nth pattern string that indicates how the event names are generated for each collision detected. See addOutPattern().

Return type

Sequence[string]

setAgainPattern(again_pattern: str) → None

This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern.

Deprecated: Use addAgainPattern() instead.

setInPattern(in_pattern: str) → None

This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern.

Deprecated: Use addInPattern() instead.

setOutPattern(out_pattern: str) → None

This method is deprecated; it completely replaces all the in patterns that have previously been set with the indicated pattern.

Deprecated: Use addOutPattern() instead.