GetPlayerSimplestTask

From Multi Theft Auto: Wiki
Revision as of 21:01, 20 April 2011 by Arran Fortuna (talk | contribs)
Jump to navigation Jump to search

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.


Please use getPedSimplestTask

This function is used to get the name of a specified players current simplest task.
DP2 note: Don't call this on players that have not spawned. This will crash the client.

Syntax

string getPlayerSimplestTask ( player thePlayer )

Required Arguments

  • thePlayer: The player whose task you want to retrieve.

Returns

Returns a string representing the name of the player's simplest, active task.

Example

This example prints the name of a players simplest task to the chat, when they use the "sTask" command.

function showSTask ()
  local thetask = getPlayerSimplestTask ( getLocalPlayer() )
  outputChatBox ( getPlayerName ( getLocalPlayer() ) .. "'s simplest task is: " .. thetask )
end
addCommandHandler ( "sTask", showSTask )

See Also