GetPlayerTask: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Visual improvement)
 
(10 intermediate revisions by 8 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
This function is used to get the current task-name of a certain type for a player.
{{Client function}}
{{Deprecated|getPedTask}}
 
This function is used to get the name of the current task of a certain type for a player.


==Syntax==
==Syntax==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
string getPlayerTask ( player thePlayer, string priority, int type, [int index = 0] )
string getPlayerTask ( player thePlayer, string priority, int taskType, [int index = 0] )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===
===Required Arguments===
*'''thePlayer''': The [[player]] whose task you want to retrieve.
*'''thePlayer''': The [[player]] whose task you want to retrieve.
*'''priority''': A string determining which set of tasks you want to retrieve it from. This must be either "priority" or "secondary".
*'''priority''': A string determining which set of tasks you want to retrieve it from. This must be either "primary" or "secondary".
*'''type''': An integer value representing the task-type (or slot) you want to get the task from. Types can be:
*'''taskType''': An integer value representing the task type (or slot) you want to get the task from. Types can be:
**'''PRIMARY TASKS'''
**'''PRIMARY TASKS'''
***'''0:''' TASK_PRIORITY_PHYSICAL_RESPONSE
***'''0:''' TASK_PHYSICAL_RESPONSE
***'''1:''' TASK_PRIORITY_EVENT_RESPONSE_TEMP
***'''1:''' TASK_EVENT_RESPONSE_TEMP
***'''2:''' TASK_PRIORITY_EVENT_RESPONSE_NONTEMP
***'''2:''' TASK_EVENT_RESPONSE_NONTEMP
***'''3:''' TASK_PRIORITY_PRIMARY
***'''3:''' TASK_PRIMARY
***'''4:''' TASK_PRIORITY_DEFAULT
***'''4:''' TASK_DEFAULT
**'''SECONDARY TASKS'''
**'''SECONDARY TASKS'''
***'''0:''' TASK_SECONDARY_ATTACK
***'''0:''' TASK_SECONDARY_ATTACK
Line 26: Line 29:


===Optional Arguments===
===Optional Arguments===
*'''index''': An integer value representing how many sub-tasks to go through. -1 to get the simplest task, 0 to get the most complex task.
*'''index''': An integer value representing how many sub tasks to go through. -1 to get the simplest task, 0 to get the most complex task.


===Returns===
===Returns===
Line 32: Line 35:


==Example==
==Example==
This example prints the name of a players task to the chat, when they use the "task" command
<section name="Client" class="client" show="true">
This example prints the name of a player's task to the chat when they use the "task" command in the console.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addCommandHandler ( "task", "task" )
function myTask ( commandName, priority, taskType )
function task ( source, key, priority, type )
    task = getPlayerTask ( source, priority, tonumber(taskType) )
  task = getPlayerTask ( source, priority, type )
    taskName = "none"
  taskName = "none"
    if ( task ) then
  if ( task ) then
        taskName = task
    taskName = task
    end
  end
    outputChatBox ( getPlayerName( source ) .. "'s " .. priority .. "(" .. taskType .. ") task is: " .. taskName )
  outputChatBox ( getClientName ( source ) .. "'s " .. priority .. "(" .. type .. ") task is: " .. taskName )
end     
end     
 
addCommandHandler ( "task", myTask )
</syntaxhighlight>
</syntaxhighlight>
</section>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}

Latest revision as of 11:06, 26 June 2014

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use getPedTask instead.


This function is used to get the name of the current task of a certain type for a player.

Syntax

string getPlayerTask ( player thePlayer, string priority, int taskType, [int index = 0] )

Required Arguments

  • thePlayer: The player whose task you want to retrieve.
  • priority: A string determining which set of tasks you want to retrieve it from. This must be either "primary" or "secondary".
  • taskType: An integer value representing the task type (or slot) you want to get the task from. Types can be:
    • PRIMARY TASKS
      • 0: TASK_PHYSICAL_RESPONSE
      • 1: TASK_EVENT_RESPONSE_TEMP
      • 2: TASK_EVENT_RESPONSE_NONTEMP
      • 3: TASK_PRIMARY
      • 4: TASK_DEFAULT
    • SECONDARY TASKS
      • 0: TASK_SECONDARY_ATTACK
      • 1: TASK_SECONDARY_DUCK
      • 2: TASK_SECONDARY_SAY
      • 3: TASK_SECONDARY_FACIAL_COMPLEX
      • 4: TASK_SECONDARY_PARTIAL_ANIM
      • 5: TASK_SECONDARY_IK

Optional Arguments

  • index: An integer value representing how many sub tasks to go through. -1 to get the simplest task, 0 to get the most complex task.

Returns

Returns a string containing the name of a task. See list of player tasks for valid strings. Returns false if invalid arguments are specified or if there is no task of the type or index specified.

Example

Click to collapse [-]
Client

This example prints the name of a player's task to the chat when they use the "task" command in the console. 

function myTask ( commandName, priority, taskType )
    task = getPlayerTask ( source, priority, tonumber(taskType) )
    taskName = "none"
    if ( task ) then
        taskName = task
    end
    outputChatBox ( getPlayerName( source ) .. "'s " .. priority .. "(" .. taskType .. ") task is: " .. taskName )
end    
addCommandHandler ( "task", myTask )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/GetPlayerTask?oldid=40321"