SetPlayerRotation: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(9 intermediate revisions by 5 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
{{Server client function}}
{{Deprecated|setElementRotation}}


__NOTOC__  
__NOTOC__  
Thid function allows you to set the current rotation of the specified player.
This function allows you to set the current rotation of the specified player.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setPlayerRotation ( player theplayer, float rotation )         
bool setPlayerRotation ( player thePlayer, float rotation )         
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''theplayer:''' An [[player]] referring to a player.
*'''thePlayer:''' The [[player]] to set the rotation of
*'''rotation:''' A [[float]] specifying the desired rotation.
*'''rotation:''' A [[float]] specifying the desired rotation in degrees.


===Returns===
===Returns===
Line 17: Line 18:


==Example==  
==Example==  
This example does...
This example allows a player to type the command 'disco', which will result in the player being rotated to a random direction every 1 second, infinite times.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">function discoTime ( player )
-- rotate the player, so that he looks to the south
    -- Randomly choose a new player rotation and set it
setPlayerRotation ( player, 180 )
    newRotation = math.random ( 0, 360 )
</syntaxhighlight>
    setPlayerRotation ( player, newRotation )
end
 
function initiateDiscoMode ( player, commandName )
    --Trigger a random change in player rotation every second
    --Send the stored 'activating player' to the discoTime
    --function, so his rotation will be changed.
    setTimer (discoTime, 1000, 0, player )
end
addCommandHandler ( "disco", initiateDiscoMode )</syntaxhighlight>


==See Also==
==See Also==
{{Player functions}}
{{Player functions}}
[[Category:Incomplete]]

Latest revision as of 22:13, 5 July 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 setElementRotation instead.


This function allows you to set the current rotation of the specified player.

Syntax

bool setPlayerRotation ( player thePlayer, float rotation )

Required Arguments

  • thePlayer: The player to set the rotation of
  • rotation: A float specifying the desired rotation in degrees.

Returns

Returns true if successful, false otherwise.

Example

This example allows a player to type the command 'disco', which will result in the player being rotated to a random direction every 1 second, infinite times. 

function discoTime ( player )
     -- Randomly choose a new player rotation and set it
     newRotation = math.random ( 0, 360 )
     setPlayerRotation ( player, newRotation )
end

function initiateDiscoMode ( player, commandName )
     --Trigger a random change in player rotation every second
     --Send the stored 'activating player' to the discoTime
     --function, so his rotation will be changed.
     setTimer (discoTime, 1000, 0, player )
end
addCommandHandler ( "disco", initiateDiscoMode )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetPlayerRotation?oldid=40563"