SetElementAttachedOffsets: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Server client function}} This function updates the offsets of an element that has been attached to another element using attachElementToElement. ==Syntax== <syntaxhighlight lang="lua">...)
 
(Fix oop syntax)
 
(12 intermediate revisions by 8 users not shown)
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 [[attachElementToElement]].
This function updates the offsets of an element that has been attached to another element using [[attachElements]].


==Syntax==  
==Syntax==  
Line 7: Line 7:
bool setElementAttachedOffsets ( element theElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ])
bool setElementAttachedOffsets ( element theElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ])
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[element]]:setAttachedOffsets||getElementAttachedOffsets}}


===Required Arguments===  
===Required Arguments===  
Line 24: Line 25:


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
<section name="Client" class="client" show="true">
This example does...
'''Example:''' This example creates a car with a minigun
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--TODO
-- Offsets
local x,y,z,rx,ry,rz= 0,-1.5,-0.1,0,0,-90
 
function createArmedBobcat(cmd)
    local lx,ly,lz = getElementPosition(root) -- 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}}
[[Category:Needs_Example]]

Latest revision as of 13:46, 6 August 2016

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

Syntax

bool setElementAttachedOffsets ( element theElement, [ float xPosOffset, float yPosOffset, float zPosOffset, float xRotOffset, float yRotOffset, float zRotOffset ])

OOP Syntax Help! I don't understand this!

Method: element:setAttachedOffsets(...)
Counterpart: getElementAttachedOffsets


Required Arguments

  • theElement: The attached element.

Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use. For more information on optional arguments, see optional arguments.

  • 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 true if the attaching process was successful, false otherwise.

Example

Click to collapse [-]
Client

Example: This example creates a car with a minigun 

-- Offsets
local x,y,z,rx,ry,rz= 0,-1.5,-0.1,0,0,-90

function createArmedBobcat(cmd)
    local lx,ly,lz = getElementPosition(root) -- 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)

See Also


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