Multi Theft Auto: Wiki - User contributions [en]

SetPedCanBeKnockedOffBike

2024-10-24T11:20:34Z

Lordmau5: Add information about peds not getting knocked off bikes when it's set damage proof (The game apparently skips collisions when this is set)

__NOTOC__
{{Client function}}
This function controls if a ped can fall of his bike by accident - namely by banging into a wall.
{{Note | This effect is not synced for peds. When the ped falls off, he will not have exited the vehicle. To get it working you need to call it each time the ped is streamed in & each time it gets a new syncer.}}
{{Note | The ped will not get knocked off a bike that is set damage proof through [[setVehicleDamageProof]]. Refer to the note on that method for more information.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedCanBeKnockedOffBike ( ped thePed, bool canBeKnockedOffBike )
</syntaxhighlight>

{{OOP||[[ped]]:setCanBeKnockedOffBike||canPedBeKnockedOffBike}}

===Required Arguments===
*'''thePed:''' the ped whose knockoffstatus is being changed
*'''canBeKnockedOffBike:''' ''true'' or ''false''

==Example==
This example adds a console command with which the local player can toggle if he can fall off bikes.

<syntaxhighlight lang="lua">
function changeCanBeKnockedOff()
local canBeKnocked = canPedBeKnockedOffBike(localPlayer)
local knockedText = canBeKnocked and "Now you can't be knocked off your bike." or "Now you can be knocked off your bike."

setPedCanBeKnockedOffBike(localPlayer, not canBeKnocked)
outputChatBox(knockedText)
end
addCommandHandler("knock", changeCanBeKnockedOff)
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

SetVehicleDamageProof

2024-10-24T11:20:05Z

Lordmau5: Add information about peds not getting knocked off bikes when it's set damage proof (The game apparently skips collisions when this is set)

__NOTOC__
{{Server client function}}
This functions makes a vehicle damage proof, so it won't take damage from bullets, hits, explosions or fire. A damage proof's vehicle health can still be changed via script.
{{Note | Setting a bike damage proof will have the side-effect of peds not being able to get knocked off anymore, even if [[setPedCanBeKnockedOffBike]] is set to true.
Consider using and cancelling the [[onVehicleDamage]] / [[onClientVehicleDamage]] events instead.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleDamageProof ( vehicle theVehicle, bool damageProof )
</syntaxhighlight>
{{OOP||[[vehicle]]:setDamageProof|damageProof|isVehicleDamageProof}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to make damage proof.
*'''damageProof:''' ''true'' is damage proof, ''false'' is damageable.

===Returns===
Returns ''true'' if the vehicle was set damage proof succesfully, ''false'' if the arguments are invalid or it failed.

==Example==
This example spawns a vehicle and sets it damage proof immediately.
<syntaxhighlight lang="lua">
newvehicle = createVehicle(602, 0, 0, 6)
setVehicleDamageProof(newvehicle, true)
</syntaxhighlight>

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

HasElementData

2020-03-20T18:24:04Z

Lordmau5: Improve upon the example

__NOTOC__
{{Server client function}}
This function checks if an element has [[element data]] available under a certain key.

==Syntax==
<syntaxhighlight lang="lua">bool hasElementData ( element theElement, string key [, bool inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:hasData}}

===Required Arguments===
*'''theElement:''' This is the element with data you want to check.
*'''key:''' The name of the element data entry you want to check for. (Maximum 31 characters.)

===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

===Returns===
This function returns ''true'' if the element contains element data for ''key'', or ''false'' if the element doesn't exist or there is no data associated with the ''key''.

==Example==
This example outputs a player's favorite animal using a console function 'favoriteAnimal' if they have one set.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function favoriteAnimal ( source, commandName, playerName )
local thePlayer = source
if playerName then -- see if a player was specified
thePlayer = getPlayerFromName (playerName) -- get the player element for the specified player
if not thePlayer then -- if we still couldn't find a player with the specified name...
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
return
end
end

if hasElementData ( thePlayer, "favoriteAnimal" ) then -- check if the player has a favorite animal set
local favoriteAnimal = getElementData ( thePlayer, "favoriteAnimal" ) -- get the player's favorite animal
outputChatBox ( getPlayerName ( thePlayer ).."'s favorite animal is: "..favoriteAnimal, source ) -- output the player's favorite animal
else
outputChatBox ( getPlayerName ( thePlayer ).." does not have a favorite animal!", source ) -- output the player's lack of a favorite animal
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "favoriteAnimal", favoriteAnimal )
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.5.7-20447|1.5.7-20447|}}

==See Also==
{{Element functions}}

Template:Element functions

2020-03-20T17:55:27Z

Lordmau5: Add hasElementData to the Wiki

*[[attachElements]]
*[[clearElementVisibleTo]]
*[[cloneElement]]
*[[createElement]]
*[[destroyElement]]
*[[detachElements]]
*[[getAllElementData]]
*[[getAttachedElements]]
*[[getElementAlpha]]
*[[getElementAttachedOffsets]]
*[[getElementAttachedTo]]
*[[getElementCollisionsEnabled]]
*[[getElementByID]]
*[[getElementByIndex]]
*[[getElementChild]]
*[[getElementChildren]]
*[[getElementChildrenCount]]
*[[getElementColShape]]
*[[getElementData]]
*[[getElementDimension]]
*[[getElementHealth]]
*[[getElementID]]
*[[getElementInterior]]
*[[getElementMatrix]]
*[[getElementModel]]
*[[getElementParent]]
*[[getElementPosition]]
*[[getElementRotation]]
*[[getElementSyncer]]
*[[getElementType]]
*[[getElementVelocity]]
*[[getElementZoneName]]
*[[getElementsByType]]
*[[getElementsWithinColShape]]
*[[getLowLODElement]]
*[[getRootElement]]
{{New items|3.0160|1.5.7|
*[[hasElementData]]
|20447}}
*[[isElement]]
*[[isElementAttached]]
*[[isElementCallPropagationEnabled]]
*[[isElementDoubleSided]]
*[[isElementFrozen]]
*[[isElementInWater]]
*[[isElementLowLOD]]
*[[isElementVisibleTo]]
*[[isElementWithinColShape]]
*[[isElementWithinMarker]]
*[[removeElementData]]
*[[setElementAlpha]]
{{New items|3.0156|1.5.5|
* [[setElementAngularVelocity]]
* [[getElementAngularVelocity]]
|14165}}
*[[setElementAttachedOffsets]]
*[[setElementCallPropagationEnabled]]
*[[setElementCollisionsEnabled]]
*[[setElementData]]
*[[setElementDimension]]
*[[setElementDoubleSided]]
*[[setElementFrozen]]
*[[setElementHealth]]
*[[setElementID]]
*[[setElementInterior]]
*[[setElementModel]]
*[[setElementParent]]
*[[setElementPosition]]
*[[setElementRotation]]
*[[setElementSyncer]]
*[[setElementVelocity]]
*[[setElementVisibleTo]]
*[[setLowLODElement]]
<noinclude>[[Category:Functions templates]]</noinclude>

SetElementRotation

2020-03-12T19:34:49Z

Lordmau5: Add rotation variable to OOP syntax

{{Server client function}}
__NOTOC__
Sets the rotation of elements according to the world (does not work with players that are on the ground).
{{Tip|New scripts should set '''conformPedRotation''' to ''true'' when using this function on [[Ped|peds]]. This will prevent quirky old behaviour.}}
==Syntax==
<syntaxhighlight lang="lua">
bool setElementRotation ( element theElement, float rotX, float rotY, float rotZ [, string rotOrder = "default", bool conformPedRotation = false ] )
</syntaxhighlight>
{{OOP||[[element]]:setRotation|rotation|getElementRotation}}

===Required Arguments===
*'''theElement:''' The element whose rotation will be set
*'''rotX:''' The element's rotation around the x axis in degrees
*'''rotY:''' The element's rotation around the y axis in degrees
*'''rotZ:''' The element's rotation around the z axis in degrees

===Optional Arguments===
{{New feature|3.0110|1.1|
*'''rotOrder:''' A string representing the rotation order desired when interpreting the provided [http://en.wikipedia.org/wiki/Euler_angles euler angles]. If omitted, default value is ''"default"''. Allowed values are:
**''"default":'' default MTA behavior prior to 1.1, where rotation order depends on element type
**''"ZXY":'' rotation about the Z axis (''up''), then about the resulting X axis (''right''), and finally about the resulting Y axis (''front''). This is the default rotation order for [[object|objects]]
**''"ZYX":'' rotation about the Z axis (''up''), then about the resulting Y axis (''front''), and finally about the resulting X axis (''right''). This is the default rotation order for [[vehicle|vehicles]]

The default rotation order for peds/players is -Z-Y-X but this rotation order (set using ''"default"'' on peds) can not be set manually on other element types since it only exists due to historical and backward compatibility reasons.
Specifying a rotation order other than ''"default"'' allows the same angles to be uniformly used on several elements without having to consider their type.
}}
{{New feature/item|3.0152|1.3.2|4680|
*'''conformPedRotation:''' ''Relevant only for peds and will be ignored for other element types.'' A bool which should be set to ''true'' to ensure the ped rotation is correctly set in all circumstances. Failing to set this argument may result in the ped rotation being inverted whilst it is in the air and other inconsistencies. The default value of false is for backward compatibility with scripts which may depend upon the incorrect behaviour.
}}

===Returns===
Returns ''true'' if the element rotation was successfully set and ''false'' otherwise.

==Example==
How to correctly set the rotation for a ped:
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function pedRotate ( )
local rotX, rotY, rotZ = getElementRotation(localPlayer) -- get the local players's rotation
setElementRotation(localPlayer,0,0,rotZ+10,"default",true) -- turn the player 10 degrees clockwise
end
addCommandHandler ( "turn", pedRotate )
</syntaxhighlight>
</section>

When a player used the command "turn" and they are the driver of a vehicle the vehicle will rotate 10 degrees clockwise
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function carRotate( )
if isPedInVehicle(localPlayer) then -- if the local client is in a vehicle
localVehicle = getPedOccupiedVehicle(localPlayer)
if getVehicleController(localVehicle) == localPlayer then -- if the local client is the controller (driver) of the vehicle
local rotX, rotY, rotZ = getElementRotation(localVehicle) -- get the local client's vehicle rotation
setElementRotation(localVehicle,rotX,rotY,rotZ+10) -- turn the vehicle 10 degrees clockwise
end
end
end
addCommandHandler ( "turn", carRotate )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04680|Added conformPedRotation argument}}

==See Also==
{{Client_element_functions}}