SetElementAngularVelocity: Difference between revisions

Latest revision as of 18:56, 29 October 2023

Sets the angular velocity of a specified, supported element (Applies a spin to it).

Syntax

bool setElementAngularVelocity ( element theElement, float rx, float ry, float rz )

OOP Syntax Help! I don't understand this!

Method: element:setAngularVelocity(...)

Variable: .angularVelocity

Counterpart: getElementAngularVelocity

Required Arguments

theElement: The element to apply the spin to. Can be either a player, ped, object, vehicle or a custom weapon.
rx: velocity around the X axis
ry: velocity around the Y axis
rz: velocity around the Z axis

Returns

Returns true if it was succesful, false otherwise.

Example

function onColShapeHit ( thePlayer, matchingDimension )
    -- When a player hits the collision shape, give him a spin
    setElementAngularVelocity ( thePlayer, 0, 0, 20 )
end
addEventHandler ( "onColShapeHit", root, onColShapeHit )

Requirements

Minimum server version	1.5.5-9.14060
Minimum client version	1.5.5-9.14060

Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version server="1.5.5-9.14060" client="1.5.5-9.14060" />

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Server client function}}
-{{New feature/item|3.0156|1.5.5|14060|Sets the angular velocity of a specified, supported element (Applies a spin to it).}}
+{{New feature/item|3.0156|1.5.5|14165|Sets the angular velocity of a specified, supported element (Applies a spin to it).}}
 ==Syntax==
 <syntaxhighlight lang="lua">
 bool setElementAngularVelocity ( element theElement, float rx, float ry, float rz )
 </syntaxhighlight>
 {{OOP||[[element]]:setAngularVelocity|angularVelocity|getElementAngularVelocity}}
 ===Required Arguments===
-*'''theElement:''' The [[element]] to apply the spin to. Can be either a [[player]], [[ped]], [[object]], [[vehicle]] or a [[Element/Weapon|custom weapon]]. '''Server side supports only vehicles currently.'''
+*'''theElement:''' The [[element]] to apply the spin to. Can be either a [[player]], [[ped]], [[object]], [[vehicle]] or a [[Element/Weapon|custom weapon]].
 *'''rx:''' velocity around the X axis
 *'''ry:''' velocity around the Y axis
@@ Line 25: / Line 25: @@
 addEventHandler ( "onColShapeHit", root, onColShapeHit )
 </syntaxhighlight>
+==Requirements==
+{{Requirements|1.5.5-9.14060|1.5.5-9.14060|}}
 ==See Also==
 {{Element functions}}