GetPlayerSurfingObjectID

GetPlayerSurfingObjectID

Description:

Function GetPlayerSurfingObjectID returns the ID of the object the player is surfing on.

Function GetPlayerSurfingObjectID was added in 0.3c R3 and will not work in earlier versions!

Parameters:

(playerid)

int

playerid

The ID of the player surfing the object.

Return Values:

The ID of the moving object the player is surfing. If the player isn't surfing a moving object, it will return INVALID_OBJECT_ID

Examples:

Example 1

/* when the player types 'objectsurfing' in to the chat box, they'll see this.*/
public OnPlayerText(playerid, text[])
{
	if(strcmp(text, "objectsurfing", true) == 0)
	{
		new
		    szMessage[30];
 
		format(szMessage, sizeof(szMessage), "You're surfing on object #%d.", GetPlayerSurfingObjectID(playerid));
		SendClientMessage(playerid, 0xA9C4E4FF, szMessage);
	}
	return 0;
}

Related Functions

The following functions may be useful, as they are related to this function in one way or another.

• GetPlayerSurfingVehicleID: Gets the ID of the vehicle that the player is surfing on.