SetObjectRotation: Difference between revisions

Latest revision as of 16:17, 13 February 2015

	This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
	Please use setElementRotation instead.

Allows you to change an object's rotation while playing a map. The object can be from the map file or created in a script.

Syntax

bool setObjectRotation ( object theObject, float rotX, float rotY, float rotZ )

Required Arguments

theObject: The object to be rotated
rotX: Rotation around the X axis
rotY: Rotation around the Y axis
rotZ: Rotation around the Z axis

Returns

Returns true if successful, false otherwise.

Example

In this example, I refer to an object in the map file with the ID "pirateship":

<object id="pirateship" posX="-1627.319092" posY="128.543411" posZ="6.581001" rotX="-0.760854" rotY="2.421000" rotZ="0.851000" model="8493"/>

function onResourceStart ( name, root )
    -- predefined variables, needed for the math code below
    rotX = 0
    rotY = 0
    rotZ = 0
    -- assign element named 'pirateship' in map file to variable
    pirateship = getElementByID ( "pirateship" )
end

function chatboxShipRotateLeft ( playerSource, commandName ) -- On console command 'increaserotations'
    outputChatBox ( "Rotational values increased" )
    -- rotations = rotations + 10
    rotX = rotX + 10
    rotY = rotY + 10
    rotZ = rotZ + 10
    -- Changed rotation is applied
    setObjectRotation ( pirateship, rotX, rotY, rotZ )
end     

function chatboxShipRotateRight ( playerSource, commandName ) -- On console command 'decreaserotations'
    outputChatBox ( "Rotational values decreased" )
    -- rotations = rotations - 10
    rotX = rotX - 10
    rotY = rotY - 10
    rotZ = rotZ - 10
    -- Changed rotation is applied
    setObjectRotation ( pirateship, rotX, rotY, rotZ )
end

-- Set up event and command handlers
addEventHandler ( "onResourceStart", resourceRoot, onResourceStart )

addCommandHandler ( "increaserotations", chatboxShipRotateLeft )
addCommandHandler ( "decreaserotations", chatboxShipRotateRight )

@@ Line 1: / Line 1: @@
 __NOTOC__
-Allows you to change an objects rotation while playing a map. The object can be from the map file or created in a script.
+{{Server client function}}
+{{Deprecated|setElementRotation|}}
+Allows you to change an object's rotation while playing a map. The object can be from the map file or created in a script.
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool setObjectRotation ( element object, float rx, float ry, float rz )
+bool setObjectRotation ( object theObject, float rotX, float rotY, float rotZ )
 </syntaxhighlight>
 ===Required Arguments===
-*'''Object:''' The object to be rotated
+*'''theObject:''' The object to be rotated
-*'''rx:''' Rotation X value
+*'''rotX:''' Rotation around the X axis
-*'''ry:''' Rotation Y value
+*'''rotY:''' Rotation around the Y axis
-*'''rz:''' Rotation Z value
+*'''rotZ:''' Rotation around the Z axis
 ===Returns===
@@ Line 17: / Line 20: @@
 ==Example==
-In this example, I refer to an object in the mapfile with the ID "pirateship":
+In this example, I refer to an object in the map file with the ID "pirateship":
 <syntaxhighlight lang="xml">
-<object id="Pirate Ship" posX="-1627.319092" posY="128.543411" posZ="6.581001" rotX="-0.760854" rotY="2.421000" rotZ="0.851000" model="8493"/>
+<object id="pirateship" posX="-1627.319092" posY="128.543411" posZ="6.581001" rotX="-0.760854" rotY="2.421000" rotZ="0.851000" model="8493"/>
 </syntaxhighlight>
 <syntaxhighlight lang="lua">
-addEventHandler ( "onMapLoad", root, "onMapLoad" )
+function onResourceStart ( name, root )
-function onMapLoad ( name, root )
+    -- predefined variables, needed for the math code below
-rx = 0
+    rotX = 0
-ry = 0
+    rotY = 0
-rz = 0 -- predefined varibles, for math code below
+    rotZ = 0
-pirateship = getElementByID ( "pirateship" ) --assign element named 'pirateship' in map file to varible
+    -- assign element named 'pirateship' in map file to variable
+    pirateship = getElementByID ( "pirateship" )
 end
-addCommandHandler ( "increaserotations", "chatboxShipRotateLeft" ) --On console command 'increaserotations', execute code
+function chatboxShipRotateLeft ( playerSource, commandName ) -- On console command 'increaserotations'
-function chatboxShipRotateLeft ( playerSource, commandName )
+    outputChatBox ( "Rotational values increased" )
-outputChatBox ( "Rotational values increased" )
+    -- rotations = rotations + 10
-rx = rx + 10
+    rotX = rotX + 10
-ry = ry + 10
+    rotY = rotY + 10
-rz = rz + 10 -- rotations = rotations + 10
+    rotZ = rotZ + 10
-setObjectRotation ( pirateship, rx, ry, rz ) --Changed rotation is applied
+    -- Changed rotation is applied
-end
+    setObjectRotation ( pirateship, rotX, rotY, rotZ )
+end
-addCommandHandler ( "decreaserotations", "chatboxShipRotateRight" ) --Repeat and subtracted values to decrease rotations
+function chatboxShipRotateRight ( playerSource, commandName ) -- On console command 'decreaserotations'
-function chatboxShipRotateRight ( playerSource, commandName )
+    outputChatBox ( "Rotational values decreased" )
-outputChatBox ( "Rotational values decreased" )
+    -- rotations = rotations - 10
-rx = rx - 10
+    rotX = rotX - 10
-ry = ry - 10
+    rotY = rotY - 10
-rz = rz - 10
+    rotZ = rotZ - 10
-setObjectRotation ( pirateship, rx, ry, rz )
+    -- Changed rotation is applied
+    setObjectRotation ( pirateship, rotX, rotY, rotZ )
 end
+-- Set up event and command handlers
+addEventHandler ( "onResourceStart", resourceRoot, onResourceStart )
+addCommandHandler ( "increaserotations", chatboxShipRotateLeft )
+addCommandHandler ( "decreaserotations", chatboxShipRotateRight )
 </syntaxhighlight>
 ==See Also==
 {{Object functions}}

SetObjectRotation: Difference between revisions

Latest revision as of 16:17, 13 February 2015

Syntax

Required Arguments

Returns

Example

See Also

Navigation menu

Search