GetPlayerSimplestTask: 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__
{{Client function}}
{{Client function}}
This function is used to get the name of a specified players current simplest [[task]].
This function is used to get the name of a specified players current simplest [[task]].<br>
'''DP2 note:''' Don't call this on players that have not spawned. This will crash the client.
'''DP2 note:''' Don't call this on players that have not spawned. This will crash the client.



Revision as of 21:47, 20 January 2008

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