IF_CollisionEntity – AddCollisionGroup (Method)

Overview

Type:	Method
Available as of:	V1.0.0.0

This chapter provides information on:

Task
Description
Interface
Return Value

Task

Adds a collision group.

Description

Adding a collision group to the collision entity.

Interface

Access: PUBLIC

Return type: UDINT

Input	Data type	Description
i_ifCollisionGroup	IF_CollisionGroup	Collision group to add to the entity.

Output	Data type	Description
q_xError	BOOL	The output is set to TRUE if an error has been detected during the execution.
q_etResult	ET_Result	POU-specific output on the diagnostic; q_xError = FALSE -> Status message; q_xError = TRUE -> Diagnostic message.
q_sResultMsg	STRING(80)	Event-triggered message that gives additional information on the diagnostic state.

Return Value

The returned value is the index of the collision group added to the list. It can be used to refer to such group through the property raifCollisionGroups.