ObjectTileGrip (RSDKv4)¶
Description¶
Tries to collide with the foreground layer based on the position of object.ixpos
+ xOffset
, object.iypos
+ yOffset
.
TODO: this needs a better description to differentiate it from ObjectTileCollision()
Note
This function is best used to handle moving along surfaces. For handling simpler collision, use ObjectTileCollision() instead.
Parameters¶
cSide
-
Determines to which side of the tile the object has to collide. Can be
CSIDE_FLOOR
,CSIDE_LWALL
,CSIDE_RWALL
, orCSIDE_ROOF
. In Sonic Origins,CSIDE_LENTITY
andCSIDE_RENTITY
are available as well. xOffset
-
Horizontal offset of the object.
yOffset
-
Vertical offset of the object.
cPlane
-
Collision plane to take into account.
Return Value¶
Sets checkResult
to true
if there was collision; otherwise, it's set to false
.