ScriptedEntity Class Reference

Private Member Functions
proto native void	SetClippingInfo (vector mins, vector maxs, float radius)
	Sets collision properties for object.
proto native void	SetCollisionBox (vector mins, vector maxs)
	Sets collision box for object.
proto native void	SetCollisionSphere (float radius)
	Sets collision sphere for object.
proto native void	SetCollisionCylinder (float radius, float height)
	Sets collision cylinder for object, representing cylinder from origin(center) up to defined positive height.
private proto native void	SetCollisionCylinderTwoWayNative (float radius, float negativeHeight, float positiveHeight)
	Sets collision cylinder for object, representing cylinder from origin(center), height can be defined in both directions.
void	SetCollisionCylinderTwoWay (float radius, float negativeHeight, float positiveHeight)
	Input value validated version of SetCollisionCylinderTwoWay.
proto native void	SetTriggerShape (TriggerShape shape)
	Set the TriggerShape to be used, default is TriggerShape.BOX.
proto native TriggerShape	GetTriggerShape ()
	Get the current TriggerShape.
override bool	IsInventoryVisible ()

Member Function Documentation

GetTriggerShape()

proto native TriggerShape GetTriggerShape ( )

private

Get the current TriggerShape.

IsInventoryVisible()

override bool IsInventoryVisible ( )

inlineprivate

SetClippingInfo()

proto native void SetClippingInfo ( vector  mins, vector  maxs, float  radius  )

private

Sets collision properties for object.

Parameters

mins	vector Min values of box
maxs	vector Max values of box
radius	float Radius of bounding sphere

Note

This function is obsolete, use rather SetCollisionBox()

SetCollisionBox()

proto native void SetCollisionBox ( vector  mins, vector  maxs  )

private

Sets collision box for object.

Parameters

mins	vector Min values of box
maxs	vector Max values of box

Note

Automatically sets TriggerShape.BOX
usage :

vector mins = "-1 -1 -1";
vector maxs = "1 1 1";
SetCollisionBox(mins, maxs);

Referenced by Trigger::SetExtents().

SetCollisionCylinder()

proto native void SetCollisionCylinder ( float  radius, float  height  )

private

Sets collision cylinder for object, representing cylinder from origin(center) up to defined positive height.

Parameters

radius	float Radius of cylinder
height	float Height of cylinder

Note

Automatically sets TriggerShape.CYLINDER
usage :

SetCollisionCylinder(3, 6);

SetCollisionCylinderTwoWay()

void SetCollisionCylinderTwoWay ( float  radius, float  negativeHeight, float  positiveHeight  )

inlineprivate

Input value validated version of SetCollisionCylinderTwoWay.

Parameters

radius	float Radius of cylinder
negativeHeigh	float Negative height of cylinder
positiveHeight	float Positive height of cylinder

Note

Automatically sets TriggerShape.CYLINDER
usage :

SetCollisionCylinderTwoWayValidated(3, -3, 3);

References ErrorEx, and SetCollisionCylinderTwoWayNative().

Referenced by CylinderTrigger::EOnInit().

SetCollisionCylinderTwoWayNative()

private proto native void SetCollisionCylinderTwoWayNative ( float  radius, float  negativeHeight, float  positiveHeight  )

private

Sets collision cylinder for object, representing cylinder from origin(center), height can be defined in both directions.

Parameters

radius	float Radius of cylinder
negativeHeigh	float Negative height of cylinder
positiveHeight	float Positive height of cylinder

Note

Automatically sets TriggerShape.CYLINDER
usage :

SetCollisionCylinderTwoWay(3, -3, 3);

Referenced by SetCollisionCylinderTwoWay().

SetCollisionSphere()

proto native void SetCollisionSphere ( float  radius )

private

Sets collision sphere for object.

Parameters

radius

float Radius of cylinder

Note

Automatically sets TriggerShape.SPHERE
usage :

SetCollisionSphere(3);

Referenced by SphereTrigger::EOnInit().

SetTriggerShape()

proto native void SetTriggerShape ( TriggerShape  shape )

private

Set the TriggerShape to be used, default is TriggerShape.BOX.

---

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

• P:/scripts/3_Game/Entities/ScriptedEntity.c