BaseDamageAreaShape Interface Reference

Inheritance diagram for BaseDamageAreaShape:

Public Member Functions
proto external vector	GetWorldPosition ()
proto external void	GetTransform (out vector mat[])
	Returns the local transform of this shape.
proto external void	SetTransform (vector mat[])
	Sets the local transform for this area damage.
proto external DamageArea	GetDamageArea ()
	Returns the damage area that is using this shape.
proto external void	GetWorldTransform (out vector mat[])
	Returns the world transform of this shape.
bool	ShouldAffectEntity (IEntity entityToAffect)
	Returns true if the entity is in the area of influence of this shape (in contact)
bool	AffectsPosition (vector position)
	Returns true if this position is contained inside of the shape.
float	GetDiameter ()
	Returns the diameter (radius * 2) of a sphere that encapsulates the entire shape.
void	Diag_DrawArea (int color)
	Called when the area has to be drawn.

Member Function Documentation

AffectsPosition()

bool BaseDamageAreaShape.AffectsPosition

(

vector

position

)

Returns true if this position is contained inside of the shape.

Implemented in SCR_ConvexPolygonDamageAreaShape.

Diag_DrawArea()

void BaseDamageAreaShape.Diag_DrawArea

(

int

color

)

Called when the area has to be drawn.

Parameters

color

The default color value to draw the area. White for disabled, red for enabled

GetDamageArea()

proto external DamageArea BaseDamageAreaShape.GetDamageArea

(

)

Returns the damage area that is using this shape.

GetDiameter()

float BaseDamageAreaShape.GetDiameter

(

)

Returns the diameter (radius * 2) of a sphere that encapsulates the entire shape.

Implemented in SCR_ConvexPolygonDamageAreaShape.

GetTransform()

proto external void BaseDamageAreaShape.GetTransform

(

out vector

mat[]

)

Returns the local transform of this shape.

GetWorldPosition()

proto external vector BaseDamageAreaShape.GetWorldPosition

(

)

GetWorldTransform()

proto external void BaseDamageAreaShape.GetWorldTransform

(

out vector

mat[]

)

Returns the world transform of this shape.

SetTransform()

proto external void BaseDamageAreaShape.SetTransform

(

vector

mat[]

)

Sets the local transform for this area damage.

ShouldAffectEntity()

bool BaseDamageAreaShape.ShouldAffectEntity

(

IEntity

entityToAffect

)

Returns true if the entity is in the area of influence of this shape (in contact)

Implemented in SCR_ConvexPolygonDamageAreaShape.

---

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

• Game/generated/Damage/DamageAreas/Shapes/BaseDamageAreaShape.c