deBaseScriptingCollider Class Reference

Scripting Module Collider Peer. More...

#include <deBaseScriptingCollider.h>

List of all members.

Public Member Functions
Constructors and Destructors
	deBaseScriptingCollider ()
	Creates a new peer.
virtual	~deBaseScriptingCollider ()
	Cleans up the peer.
Notifications
virtual void	CollisionResponse (deCollider *owner, deCollisionInfo *info)
	Determines the response for a given collision.
virtual bool	CanHitCollider (deCollider *owner, deCollider *collider)
	Determines if a collider can be hit.
virtual void	ColliderChanged (deCollider *owner)
	Notifies the scripts that the properties of this collider have changed and that the attached element has to update.

---

Detailed Description

Scripting Module Collider Peer.

Provides callbacks for the physics system to ask the game scripts if certain collisions are possible and to notify the game scripts about changes to a collider.

Author:

Plüss Roland

Version:

1.0

Date:

2008

---

Constructor & Destructor Documentation

deBaseScriptingCollider::deBaseScriptingCollider

(

)

Creates a new peer.

virtual deBaseScriptingCollider::~deBaseScriptingCollider

(

)

[virtual]

Cleans up the peer.

---

Member Function Documentation

virtual bool deBaseScriptingCollider::CanHitCollider	(	deCollider *	owner,
		deCollider *	collider
	)		[virtual]

Determines if a collider can be hit.

If this peer is used with a collider then the script is asked to determine if the two collider can hit each other. If this peer is used in a ray test owner is NULL and the script is asked to determine if the ray can hit the collider.

Parameters:

owner	Collider this peer belongs to or NULL if a ray test is done.
collider	Collider to test.

Returns:

True if the owner/ray can hit the given collider.

virtual void deBaseScriptingCollider::ColliderChanged

(

deCollider *

owner )

[virtual]

Notifies the scripts that the properties of this collider have changed and that the attached element has to update.

This is usually called after the collision detection but can also be called multiple times.

virtual void deBaseScriptingCollider::CollisionResponse	(	deCollider *	owner,
		deCollisionInfo *	info
	)		[virtual]

Determines the response for a given collision.

If you specified ertCustom you have to update the info object with the response to the collision. In all other cases you do must not modify the info object.

---

The documentation for this class was generated from the following file:

• deBaseScriptingCollider.h