Multi Theft Auto: Wiki - User contributions [en]

Template:Text functions

2008-04-14T15:38:37Z

Peter:

*[[textCreateDisplay]]

*[[textCreateTextItem]]

*[[textDestroyDisplay]]

*[[textDestroyTextItem]]

*[[textDisplayAddObserver]]

*[[textDisplayRemoveObserver]]

{{New feature|3|DP3|
*[[textDisplayIsObserver]]
*[[textDisplayGetObservers]]
}}

*[[textDisplayAddText]]

*[[textDisplayRemoveText]]

*[[textItemGetColor]]

*[[textItemGetPosition]]

*[[textItemGetPriority]]

*[[textItemGetScale]]

*[[textItemGetText]]

*[[textItemSetColor]]

*[[textItemSetPosition]]

*[[textItemSetPriority]]

*[[textItemSetScale]]

*[[textItemSetText]]

GetPlayerTask

2008-03-12T17:35:38Z

Peter: Nicknames and MTA accounts aren't the same thing =p

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

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

===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==
<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">
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 )
</syntaxhighlight>
</section>

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

Resource:Realdriveby

2008-02-23T16:56:11Z

Peter:

{{Resource page}}
== Introduction ==
RealDriveby is a fully customisable resource which allows a flexible driveby system for your server.

All of GTA's driveby compatible weapons, including the shotguns,pistols,M4 and AK-47 are supported by this resource. Shot delays for weapons such as pistols are fixed to their normal rate.

Users can switch weapons by default using the "Vehicle Look Left" and "Vehicle Look Right" keys while in driveby mode.

However, it is completely up to the admin how he or she wants drivebys to be: Using MTA's settings system, shot delays for weapons can be modified; the weapons which a driver can driveby with are customisable; the weapons a passenger can driveby with are customisable.

There are also options available to disable steering whilst in driveby mode, or disable drivebys altogether for certain vehicles.

On top of this, RealDriveby provides clientside scripting functions so that users can modify these attributes on a player-basis, allowing different players the ability to driveby different weapons and different delays.

== Settings ==
All settings can be modified using MTA's set() functions, modifying the meta.xml of the resource, or modifying the settings.xml.

===Driver weapons===
* '''Setting name:''' ''driveby_driver''
* '''Description:''' Sets the weapons that a driver can driveby with. To disable driver drivebys, just pass an empty table. See [[Resource:Realdriveby#GTA_Driveby_Compatible_weapons|here]] for compatible weapons.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_driver" value="[[ 22,23,24,26,28,29,32 ]]"/></syntaxhighlight>

===Passenger weapons===
* '''Setting name:''' ''driveby_passenger''
* '''Description:''' Sets the weapons that a passenger can driveby with. To disable passenger drivebys, just pass an empty table. See [[Resource:Realdriveby#GTA_Driveby_Compatible_weapons|here]] for compatible weapons.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_passenger" value="[[ 22,23,24,25,26,28,29,32,30,31,33 ]]"/></syntaxhighlight>

===Shot delay===
* '''Setting name:''' ''driveby_shot_delay''
* '''Description:''' Sets the delay between each individual shot for the specified weapons. Unspecified weapons have GTA's default driveby fire rate. The setting is in the format of a table where the key is a '''string''' of the weapon ID, and the value is the delay in milliseconds.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_shot_delay" value="[{ '22':300,'23':300,'24':800,'26':700 }]"/></syntaxhighlight>

===Blocked vehicles===
* '''Setting name:''' ''driveby_blocked_vehicles''
* '''Description:''' Sets the vehicles which driveby mode cannot be accessed in. Useful to block strange effects such as drivebys in tanks. In the format of an array of vehicle IDs.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_blocked_vehicles" value="[[ 432,601,437,431,592,553,577,488,497,548,563,512,476,447,425,519,520,460,417,469,487,513,441,464,501,465,564,538,449,537,539,570472,473,493,595,484,430,453,452,446,454,606,591,607,611,610,590,569,611,435,608,584,450 ]]"/></syntaxhighlight>

===Steer Cars while in driveby mode===
* '''Setting name:''' ''driveby_steer_cars''
* '''Description:''' Sets whether drivers can steer left or right while in driveby mode for vehicles besides bikes. The setting is in the format of a bool, where ''true'' allows steering.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_steer_cars" value="[true]"/></syntaxhighlight>

===Steer Bikes while in driveby mode===
* '''Setting name:''' ''driveby_steer_bikes''
* '''Description:''' Sets whether drivers can steer left or right while in driveby mode for bikes/bicycles. If set to false, it allows extra realism. The setting is in the format of a bool, where ''true'' allows steering.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_steer_bikes" value="[true]"/></syntaxhighlight>

===Toggle driveby mode key===
* '''Setting name:''' ''driveby_toggle_mode''
* '''Description:''' Sets the [[Key names|key]] which will be used to toggle driveby mode.
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_toggle_mode" value="mouse2"/></syntaxhighlight>

===Next driveby weapon key===
* '''Setting name:''' ''driveby_next_weapon''
* '''Description:''' Sets the [[Key names|key]] which will be used to change to the next driveby weapon (if there is one).
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_next_weapon" value="vehicle_look_right"/></syntaxhighlight>

===Previous driveby weapon key===
* '''Setting name:''' ''driveby_prev_weapon''
* '''Description:''' Sets the [[Key names|key]] which will be used to change to the previous driveby weapon (if there is one).
* '''XML Example:''' <syntaxhighlight lang="xml"><setting name="driveby_prev_weapon" value="vehicle_look_left"/></syntaxhighlight>

==Scripting functions==
All scripting functions are '''clientside''' and therefore only affect the '''local player'''. All functions must be called using the [[call]] function, e.g.
<syntaxhighlight lang="lua">call(getResourceFromName("realdriveby"),"setWeaponShotDelay",22,300)</syntaxhighlight>

===setDriverDrivebyAbility===
This function allows you to set what weapons the local player can use while a driver of a vehicle.
<syntaxhighlight lang="lua">
bool setDriverDrivebyAbility ( table weapons )
</syntaxhighlight>
* '''weapons:''' An an array/table containing weapon IDs that the driver may use. See [[Resource:Realdriveby#GTA_Driveby_Compatible_weapons|here]] for compatible weapons.

===getDriverDrivebyAbility===
This function allows you to retrive what weapons the local player can use while a driver of a vehicle.
<syntaxhighlight lang="lua">
table getDriverDrivebyAbility ()
</syntaxhighlight>
Returns a table of the weapons that can be used as a driver.

===setPassengerDrivebyAbility===
This function allows you to set what weapons the local player can use while a passenger of a vehicle.
<syntaxhighlight lang="lua">
bool setPassengerDrivebyAbility ( table weapons )
</syntaxhighlight>
* '''weapons:''' An an array/table containing weapon IDs that the passenger may use. See [[Resource:Realdriveby#GTA_Driveby_Compatible_weapons|here]] for compatible weapons.

===getPassengerDrivebyAbility===
This function allows you to retrive what weapons the local player can use while a passenger of a vehicle.
<syntaxhighlight lang="lua">
table getPassengerDrivebyAbility ()
</syntaxhighlight>
Returns a table of the weapons that can be used as a passenger.

===setWeaponShotDelay===
This function allows setting of a certain weapon's shot delay for the local player
<syntaxhighlight lang="lua">
bool setWeaponShotDelay(int weaponID, int delay)
</syntaxhighlight>
* '''weaponID:''' An integer representing the [[Weapons|weapon ID]] of the delay that you wish to set.
* '''delay:''' An integer representing the delay in between each shot, in '''milliseconds'''.

===getWeaponShotDelay===
This function allows retrieving of a certain weapon's shot delay for the local player
<syntaxhighlight lang="lua">
int getWeaponShotDelay(int weaponID)
</syntaxhighlight>
* '''weaponID:''' An integer representing the [[Weapons|weapon ID]] of the delay that you wish to retrieve.
Returns an integer representing the weapon delay in between each shot.

===setDrivebySteeringAbility===
This function allows setting of whether the local player can steer while in driveby mode.
<syntaxhighlight lang="lua">
bool setDrivebySteeringAbility( bool otherVehicles, bool bikes )
</syntaxhighlight>
* '''otherVehicles:''' A bool representing whether steering is enabled while in any vehicle besides a bike/bicycle, where ''true'' represents enabled steering and ''false'' represents disabled steering.
* '''bikes :''' A bool representing whether steering is enabled while in a bike/bicycle, where ''true'' represents enabled steering and ''false'' represents disabled steering.

===getDrivebySteeringAbility===
This function allows retrieving of whether the local player can steer while in driveby mode.
<syntaxhighlight lang="lua">
bool getDrivebySteeringAbility( string drivebyType )
</syntaxhighlight>
* '''drivebyType :''' A string which can either be "'''bike'''", representing bikes/bicycles, or "'''car'''" representing all other vehicles.
Returns a bool of the ability of the specified type of driveby, where ''true'' is enabled and ''false'' is disabled.

==GTA Driveby Compatible weapons==
These are weapons that are compatible with GTA/MTA's driveby mode, and can be used by this script.

<table border="1" class="unnamed1"><tr><th>Name</th><th>ID</th><td> </td><th>Name</th><th>ID</th></tr><tr><td>Pistol</td><td>22</td><td> </td><td>Silenced Pistol</td><td>23</td></tr><tr><td>Desert Eagle</td><td>24</td><td> </td><td>Chrome Shotgun</td><td>25</td> </tr><tr><td>Sawn-Off Shotgun</td><td>26</td><td> </td><td>Combat Shotgun</td><td>27</td></tr><tr><td>Uzi</td><td>28</td><td> </td><td>MP5</td><td>29</td></tr><tr><td>Tec-9</td><td>32</td><td> </td><td>AK-47</td><td> 30</td></tr><tr><td>M4</td><td>31</td><td> </td><td>Country Rifle</td><td>33</td></tr>
<tr><td>Minigun</td><td>38</td><td> </td><td></td><td></td></tr></table>

FixVehicle

2008-02-03T16:27:31Z

Peter: No such function

{{Server client function}}
__NOTOC__
This function will set a [[vehicle]]'s health to full and fix its damage model. If you wish to only change the vehicle's health, without affecting its damage model, use [[setElementHealth]].

==Syntax==
<syntaxhighlight lang="lua">
bool fixVehicle ( vehicle theVehicle )
</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The vehicle you wish to fix

===Returns===
Returns ''true'' if the vehicle was fixed, ''false'' if '''theVehicle''' is invalid.

==Example==
This example fixes all the vehicles that exist in the map.
<syntaxhighlight lang="lua">
-- Retrieve a table containing all the vehicles that exist
vehicles = getElementsByType ( "vehicle" )
-- Loop through the list, storing the vehicle from the table in the variable vehicleValue
for vehicleKey, vehicleValue in ipairs(vehicles) do
-- fix the vehicle
fixVehicle ( vehicleValue )
end
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}

SetVehiclePanelState

2008-01-24T10:20:54Z

Peter:

__NOTOC__
{{Server client function}}

This function allows you to change the state of one of the six panels vehicle's can have. When executed on the server-side resources, the damage will be synched for all players, whereas the change is only client-side if the function is used in a client resource.

==Syntax==
<syntaxhighlight lang="lua">bool setVehiclePanelState ( vehicle theVehicle, int panelID, int state )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The [[vehicle]] you would like to modify the panel of.
*'''panelID:''' 0-6
*'''state:''' 0-255 (check what range is effective, it may be much smaller e.g. 0-3)

==Returns==
Returns ''true'' if the panel state has been updated, ''false'' otherwise

==See Also==
{{Vehicle functions}}

SetVehiclePanelState

2008-01-24T10:16:25Z

Peter:

__NOTOC__
{{Server client function}}

==Syntax==
<syntaxhighlight lang="lua">setVehiclePanelState ( vehicle theVehicle, int panelID, int state )</syntaxhighlight>

==Required Arguments==
*'''theVehicle:''' The vehicle you would like to modify the panel of.
*'''panelID:''' 0-6
*'''state:''' 0-255 (check what range is effective, it may be much smaller e.g. 0-3)

==Returns==
Returns ''true'' if it works, ''false'' otherwise

==See Also==
{{Vehicle functions}}