warning Not Translated

This page has not been translated into the language that your browser requested yet. The English content is being shown as a fallback.

If you want to contribute a translation for this page then please click here.

TogglePlayerControllable

Description

Toggles whether a player can control their character or not. The player will also be unable to move their camera.

Name	Description
playerid	The ID of the player to toggle the controllability of
bool:controllable	'false' to make them uncontrollable, 'true' to make them controllable.

Returns

true - The function executed successfully.

false - The function failed to execute. The player specified does not exist.

Examples

public OnPlayerCommandText(playerid, cmdtext[])
{
     // Freezes a player when they types /freezeme
     if (strcmp(cmdtext, "/freezeme", true) == 0)
     {
          TogglePlayerControllable(playerid, false);
          return 1;
     }
     // Unfreezes a player when they types /unfreezeme
     if (strcmp(cmdtext, "/unfreezeme", true) == 0)
     {
          TogglePlayerControllable(playerid, true);
          return 1;
     }
     return 0;
}

Related Functions

IsPlayerControllable: Check if the player is controllable.