IsPlayerDoingTask: Difference between revisions

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


==Syntax==
==Syntax==
Line 7: Line 7:
===Required Arguments===
===Required Arguments===
* '''thePlayer''': A [[player]] object referencing the specified player.
* '''thePlayer''': A [[player]] object referencing the specified player.
* '''taskName''': A string containing the name of the [[task]] you're checking for.
* '''taskName''': A string containing the name of the [[List of player tasks|task]] you're checking for.


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


==Example==
==Example==

Revision as of 18:59, 30 July 2007

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


Retrieved from "https://wiki.multitheftauto.com/wiki/IsPlayerDoingTask?oldid=9440"