RadialImpulseEvent Class Reference
[Physics]

Creates a physics based impulse effect from a defined central point and magnitude. More...

List of all members.

Static Public Member Functions
static void	send (string inPosition="1.0 1.0 1.0", float radius=10.0f, float magnitude=20.0f)
	Apply a radial impulse to any SceneObjects in the area of effect.

---

Detailed Description

Creates a physics based impulse effect from a defined central point and magnitude.

See also:

RadialImpulseEvent::send

---

Member Function Documentation

static void RadialImpulseEvent::send	(	string	inPosition = "1.0 1.0 1.0",
		float	radius = 10.0f,
		float	magnitude = 20.0f
	)			[static]

Apply a radial impulse to any SceneObjects in the area of effect.

This event is performed server-side AND client-side.

Parameters:

	position	Center point for this radial impulse.
	radius	Distance from the position for this radial impulse to affect.
	magnitude	The force applied to objects within the radius from the position of this radial impulse effect.

Example:

// Define the Position
%position = "10.0 15.0 10.0";

// Define the Radius
%radius = "25.0";

// Define the Magnitude
%magnitude = "30.0"

// Create a globalRadialImpulse physics effect.
RadialImpulseEvent::send(%position,%radius,%magnitude);