HitZoneContainerComponent Interface Reference

Inheritance diagram for HitZoneContainerComponent:

Public Member Functions
proto external IEntity	GetOwner ()
proto external HitZone	GetDefaultHitZone ()
	Returns the default hitzone.
proto external int	GetHitZonesByID (out notnull array< HitZone > outHitZones, notnull array< int > hitZoneIDs)
	Clears and fills the specified outHitZones array with all HZs in this entity.
proto external int	GetHitZonesByIDInHierarchy (out notnull array< HitZone > outHitZones, notnull array< int > hitZoneIDs)
	Clears and fills the specified outHitZones array with all HZs in this entity and its children.
proto external HitZone	GetHitZoneByName (string hitZoneName)
	Get the HitZone that matches the provided collider name.
proto external HitZone	GetHitZoneByColliderID (int colliderID)
	Get the HitZone that matches the provided collider ID.
proto external int	GetHitZonesByColliderIDs (out notnull array< HitZone > outHitZones, notnull array< int > colliderIDs)
	Clears and fills the specified outHitZones array with all HZs that are attached to colliderIDs.
proto external HitZone	GetHitZone (string colliderName)
proto external int	CountAllHitZones ()
	Counts the number of hitzones in this entity.
proto external int	CountAllHitZonesInHierarchy ()
	Counts the number of hitzones in this entity and its children.
proto external int	GetAllHitZones (out notnull array< HitZone > outHitZones)
	Clears and fills the specified outHitZones array with all HZs in this entity Returns the count of elements that were filled into the array.
proto external int	GetAllHitZonesInHierarchy (out notnull array< HitZone > outHitZones)
	Clears and fills the specified outHitZones array with all HZs in this entity and its children.
proto external HitZoneContainerComponent	GetParentHitZoneContainer ()
Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Protected Member Functions
bool	HasDataToReplicate ()
	Use it to save bandwidth in some default conditions. Use it if Save and Load are overriden.
bool	OnRplSave (ScriptBitWriter writer)
bool	OnRplLoad (ScriptBitReader reader)
void	OnRegisteredToParent (notnull HitZoneContainerComponent outHitZoneContainerComponent)
	Gets called if a child HitZoneContainerComponent registers to a parent HitZoneContainerComponent.
void	OnUnRegisteredFromParent (notnull HitZoneContainerComponent outHitZoneContainerComponent)
	Gets called if a child HitZoneContainerComponent unregisters from a parent HitZoneContainerComponent.
Protected Member Functions inherited from GameComponent
void	OnDelete (IEntity owner)
	Called when Entity is being to be destroyed (deleted) or component to be deleted.

Member Function Documentation

CountAllHitZones()

proto external int HitZoneContainerComponent.CountAllHitZones

(

)

Counts the number of hitzones in this entity.

Use instead of GetAllHitZones when you only need to get the count because this function does not allocate memory.

CountAllHitZonesInHierarchy()

proto external int HitZoneContainerComponent.CountAllHitZonesInHierarchy

(

)

Counts the number of hitzones in this entity and its children.

Use instead of GetAllHitZonesInHierachy when you only need to get the count because this function does not allocate memory.

GetAllHitZones()

proto external int HitZoneContainerComponent.GetAllHitZones

(

out notnull array< HitZone >

outHitZones

)

Clears and fills the specified outHitZones array with all HZs in this entity Returns the count of elements that were filled into the array.

GetAllHitZonesInHierarchy()

proto external int HitZoneContainerComponent.GetAllHitZonesInHierarchy

(

out notnull array< HitZone >

outHitZones

)

Clears and fills the specified outHitZones array with all HZs in this entity and its children.

Returns the count of elements that were filled into the array.

GetDefaultHitZone()

proto external HitZone HitZoneContainerComponent.GetDefaultHitZone

(

)

Returns the default hitzone.

In play mode, if there are no hitzones, the component is not created. Otherwise, a default hitzone is guaranteed to be present. In edit mode, the component is always created even if no hitzone is defined. In this case the hitzone might return null.

GetHitZone()

proto external HitZone HitZoneContainerComponent.GetHitZone

(

string

colliderName

)

GetHitZoneByColliderID()

proto external HitZone HitZoneContainerComponent.GetHitZoneByColliderID

(

int

colliderID

)

Get the HitZone that matches the provided collider ID.

Only searches on the component. Returns the hitzone matching the collider ID, or null if the hitzone can't be found.

GetHitZoneByName()

proto external HitZone HitZoneContainerComponent.GetHitZoneByName

(

string

hitZoneName

)

Get the HitZone that matches the provided collider name.

Searches the entire hierarchy. Returns the hitzone matching the provided name, or null if the hitzone can't be found.

GetHitZonesByColliderIDs()

proto external int HitZoneContainerComponent.GetHitZonesByColliderIDs	(	out notnull array< HitZone >	outHitZones,
		notnull array< int >	colliderIDs )

Clears and fills the specified outHitZones array with all HZs that are attached to colliderIDs.

Returns the hitzones matching those collider IDs Returns the count of elements that were filled into the array.

GetHitZonesByID()

proto external int HitZoneContainerComponent.GetHitZonesByID	(	out notnull array< HitZone >	outHitZones,
		notnull array< int >	hitZoneIDs )

Clears and fills the specified outHitZones array with all HZs in this entity.

The ID of a hitzone is its position on the array returned by GetAllHitZones Returns the count of elements that were filled into the array.

GetHitZonesByIDInHierarchy()

proto external int HitZoneContainerComponent.GetHitZonesByIDInHierarchy	(	out notnull array< HitZone >	outHitZones,
		notnull array< int >	hitZoneIDs )

Clears and fills the specified outHitZones array with all HZs in this entity and its children.

The ID of a hitzone is its position on the array returned by GetAllHitZones Returns the count of elements that were filled into the array.

GetOwner()

proto external IEntity HitZoneContainerComponent.GetOwner

(

)

GetParentHitZoneContainer()

proto external HitZoneContainerComponent HitZoneContainerComponent.GetParentHitZoneContainer

(

)

HasDataToReplicate()

bool HitZoneContainerComponent.HasDataToReplicate ( )

protected

Use it to save bandwidth in some default conditions. Use it if Save and Load are overriden.

Implemented in SCR_DestructibleBuildingComponent.

OnRegisteredToParent()

void HitZoneContainerComponent.OnRegisteredToParent ( notnull HitZoneContainerComponent outHitZoneContainerComponent )

protected

Gets called if a child HitZoneContainerComponent registers to a parent HitZoneContainerComponent.

OnRplLoad()

bool HitZoneContainerComponent.OnRplLoad ( ScriptBitReader reader )

protected

Implemented in SCR_DestructibleBuildingComponent.

OnRplSave()

bool HitZoneContainerComponent.OnRplSave ( ScriptBitWriter writer )

protected

Implemented in SCR_DestructibleBuildingComponent.

OnUnRegisteredFromParent()

void HitZoneContainerComponent.OnUnRegisteredFromParent ( notnull HitZoneContainerComponent outHitZoneContainerComponent )

protected

Gets called if a child HitZoneContainerComponent unregisters from a parent HitZoneContainerComponent.

---

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

• Game/generated/Components/HitZoneContainerComponent.c