IsPlayerDoingTask: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
{{Deprecated}}
This function checks if the specified player is carrying out a certain [[List of player tasks|task]].
This function checks if the specified player is carrying out a certain [[List of player tasks|task]].



Revision as of 14:29, 20 January 2009

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions, but there should be a more generic way to perform what it does.

This function checks if the specified player is carrying out a certain task.

Syntax

bool isPlayerDoingTask ( player thePlayer, string taskName )

Required Arguments

  • thePlayer: A player object referencing the specified player.
  • taskName: A string containing the name of the task you're checking for.

Returns

Returns true if the player is currently doing the task, false otherwise.

Example

This example checks if the player who entered the 'doingdriveby' command is doing a drive-by (clientside).

function amIDoingADriveby ()
  if ( isPlayerDoingTask ( getLocalPlayer(), "TASK_SIMPLE_GANG_DRIVEBY" ) ) then
    outputChatBox ( getPlayerName ( getLocalPlayer() ) .. " is doing a driveby!!!" )
  else
    outputChatBox ( getPlayerName ( getLocalPlayer() ) .. " is not doing a driveby" )
  end
end
addCommandHandler ( "doingdriveby", amIDoingADriveby )

See Also