pXent_settype

pXent_settype ( entity, var type, var hull )

Registers / unregisters an entity with the physics system. After registering, the entity will be under control of the physics system and a "PhysX Actor" is created (the entity group id is automatically set to 1). After unregistering, the Actor is deleted and the entity is no longer controlled by physics.

Parameters:

entity	Entity pointer to be registered / unregistered, or NULL for registering the level.
type	PH_STATIC = register the entity as a static obstacle. PH_RIGID = register the entity as a dynamic rigid body that can move (model entities only). PH_CHAR = register the entity as a character controller (model entities only). 0 = unregister the entity from the physics system.
hull	Collision hull: PH_BOX, PH_SPHERE, PH_CAPSULE, PH_POLY, PH_CONVEX, PH_TERRAIN or PH_PLANE

Returns:

1 if successful, 0 otherwise.

Remarks:

This function has to be called after setting the object's position and scale, and before executing any other pXent_ functions.
The first time a specific entity is registered, this instruction is medium because some calculations need to be done.
An entity must be unregistered before removing it or changing the level. Normally this is automatically handled by physX_open.
While you can continue to read a registered entities' position and orientation, you can no longer directly change its position (x,y,z), orientation (pan, tilt, roll), or scale. Use pXent_addforce to impact forces on the entity instead. If you need to directly change position or orientation, you can temporarily disable the entity using pXent_enable.
Don't use PH_POLY or PH_CONVEX hulls for dynamic actors. Instead, use pXent_addshape for creating dynamic actors with complex shapes.
Don't use pXent_settype for wheels, only if you want to create wheels with pXcon_add6djoint.
When you use PH_CHAR, you have to put a wait(1) pause after your pXent_settype functions, before you run the pXent_movechar function.
PH_CHAR works only with a PH_BOX or PH_CAPSULE hull ( all other hulls will set PH_CAPSULE ) .
PH_CONVEX is used for convex meshes, f.i. donuts. The maximum number of polygons for a convex mesh is 256.
PH_TERRAIN can be used for terrain; however it is said that PH_POLY often works better for terrains.
PH_PLANE can be used to set the collision ground plane for an otherwise empty level.
The NxActor pointer of the physics actor is stored in the entity's body parameter.

Speed:

Medium

Example 1:

ENTITY* myCrate;
// ...
// on startup
myCrate = ent_create( "crate.mdl", nullvector, any_function );
pXent_settype( myCrate, PH_RIGID, PH_BOX ); 
pXent_settype( myCrate, 0, 0 );
// ...
// during gameplay let's have fun with a crate:
var position;
pXent_settype( myCrate, PH_RIGID, PH_BOX );
position= myCrate.x; // this will give you an approximate position
//myCrate.x = position + 10; // this won't work!
pXent_settype( myCrate, 0, 0 );
myCrate.x = position + 10; // unregistered - now we can change the position

pXent_settype( myCrate, PH_RIGID, PH_BOX ); // restart from new position

Example 2:

function f_ball()
{
        VECTOR vKick;
        vKick.x = 300; vKick.y = 0; vKick.z = 100;
        pXent_settype(my, PH_RIGID, 1);
//      pXent_setmass(my, 2);
        pXent_setfriction(my, 100);
        pXent_setelasticity(my, 10);
//      pXent_setdamping(my, 0, 0);
        vec_rotate(vKick,camera.pan);
        pXent_addvelcentral(my, vKick);
        vec_set(my.blue,vector(153,247,255)); 
        my.lightrange = 25;
}

function on_mouse_right_event()
{
        while (mouse_left) {wait (1);}
        ENTITY* ball = ent_create ("explosion.mdl", camera.x, f_ball);
        set(ball,PASSABLE);
}

Example 1:

Example 2:

See also: