The function block implements the interface IF_CollisionEntity.
Access: PUBLIC
Return type: UDINT
|
Input |
Data type |
Description |
|---|---|---|
|
i_ifCollisionGroup |
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 |
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. |
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.
|
q_xError |
q_etResult |
Enumeration value |
Description |
|---|---|---|---|
|
FALSE |
0 |
Success |
|
|
TRUE |
32 |
The maximum number of collision entity groups has been reached. |
|
|
TRUE |
11 |
The provided interface is invalid (null). |
|
Enumeration name: |
MaxNumberOfCollisionEntityGroupsReached |
|
Enumeration value: |
32 |
|
Description: |
The maximum number of collision entity groups has been reached. |
|
Issue |
Cause |
Solution |
|---|---|---|
|
Could not add a collision group to the entity |
The list of collision groups for this entity is already full, meaning that udiNumberOfCollisionGroups = Gc_udiMaxNumberOfCollisionEntityGroups |
Make sure that udiNumberOfCollisionGroups < Gc_udiMaxNumberOfCollisionEntityGroups before calling this method. |