IF_CollisionGroup – AddCollisionObject (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 object.

Description

This method is used to add one collision object to the collision group.

Interface

Access: PUBLIC

Return type: UDINT

Input	Data type	Description
i_ifCollisionObject	IF_CollisionObject	Collision object to add to the group.

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 object added to the list. It can be used to refer to such object through the property raifCollisionObjects.