SetElementAttachedOffsets: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Server client function}}
{{Server client function}}
This function updates the offsets of an element that has been attached to another element using [[attachElements]].
This function returns the offsets of an element that has been attached to another element using [[attachElements]].
 
'''Note: This function is only clientside in versions which are lower then 1.0.4!'''


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementAttachedOffsets ( element theElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ])
float, float, float, float, float, float getElementAttachedOffsets ( element theElement )
</syntaxhighlight>
</syntaxhighlight>


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The attached element.
*'''theElement:''' The attached element.
===Optional Arguments===
{{OptionalArg}}
*'''xPosOffset:''' The x offset, if you want the elements to be a certain distance from one another (default 0).
*'''yPosOffset:''' The y offset (default 0).
*'''zPosOffset:''' The z offset (default 0).
*'''xRotOffset:''' The x rotation offset (default 0).
*'''yRotOffset:''' The y rotation offset (default 0).
*'''zRotOffset:''' The z rotation offset (default 0).


===Returns===
===Returns===
Returns ''true'' if the attaching process was successful, ''false'' otherwise.
Returns 6 [[float|floats]], of which the first 3 indicate the position offset (x, y, z), and the last 3 indicate the rotation offset (x, y, z), if successful. ''false'' otherwise.


==Example==  
==Example==  
<section name="Client" class="client" show="true">
'''Example:''' This example creates a car with a minigun
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- Offsets
-- TODO
local x,y,z,rx,ry,rz= 0,-1.5,-0.1,0,0,-90
 
function createArmedBobcat(cmd)
    local lx,ly,lz = getElementPosition(getLocalPlayer()) -- get the position of the player
    lx = lx + 5 -- add 5 units to the x position
   
    veh = createVehicle( 422, lx, ly, lz) -- create a bobcat
    base = createObject( 2985, 2,2,2) -- create a minigun_base object
    setElementCollisionsEnabled ( base, false ) -- the minigun_base damages the car
    -- you could alternatively load an empty col file for the minigun object
    attachElements ( base, veh,  x,y,z,rx,ry,rz) -- attach the base to the bobcat
end
 
function rotateIt(cmd, addZ)
    if(addZ) then
        rz=rz+addZ
        setElementAttachedOffsets (base,x,y,z,rx,ry,rz) --update offsets
    end
end
 
addCommandHandler("bobcat", createArmedBobcat)
addCommandHandler("rotate", rotateIt)
</syntaxhighlight>
</syntaxhighlight>
</section>
==See Also==
==See Also==
{{Element functions}}
{{Element functions}}

Revision as of 10:40, 8 November 2010

This function returns the offsets of an element that has been attached to another element using attachElements.

Syntax

float, float, float, float, float, float getElementAttachedOffsets ( element theElement )

Required Arguments

  • theElement: The attached element.

Returns

Returns 6 floats, of which the first 3 indicate the position offset (x, y, z), and the last 3 indicate the rotation offset (x, y, z), if successful. false otherwise.

Example

-- TODO

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementAttachedOffsets?oldid=24475"