attachElements | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

attachElements

Client-side
Server-side
Shared

Pair: detachElements

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function attaches one element to another, so that the first one follows the second whenever it moves.

Note

The offset coodinates reflect the object space, not the world space. This means that you cannot calculate the exact offsets between two objects by pre-positioning them in the map editor as a reference. Please see attachElementsOffsets for more details. Due to a limitation in GTA, unexpected attach rotations may occur if all rotation offsets are non-zero. (i.e. Try to ensure at least one of 'xRotOffset', 'yRotOffset' or 'zRotOffset' is zero).

OOP Syntax Help! I don't understand this!

Syntax 

bool attachElements ( element theElement, element theAttachToElement, [ float xPosOffset = 0, float yPosOffset = 0, float zPosOffset = 0, float xRotOffset = 0, float yRotOffset = 0, float zRotOffset = 0 ] )
Required Arguments
  • theElement: The element to be attached.
  • theAttachToElement: The element to attach the first to.
Optional Arguments

NOTE: When using optional arguments, you might need to supply all arguments before the one you wish to use.

  • xPosOffset (default: 0): The x offset, if you want the elements to be a certain distance from one another (default 0).
  • yPosOffset (default: 0): The y offset (default 0).
  • zPosOffset (default: 0): The z offset (default 0).
  • xRotOffset (default: 0): The x rotation offset (default 0).
  • yRotOffset (default: 0): The y rotation offset (default 0).
  • zRotOffset (default: 0): The z rotation offset (default 0).

Returns

  • bool: value

Returns true if the attaching process was successful, false otherwise.

Code Examples

shared

Example 1:This example attaches a marker to the player who steals the Mr. Whoopee:

-- create the vehicle
local vehicleMrWhoopee = createVehicle ( 423, 237.472, -54.225, 1.518, 0, 354.488, 0 )


function onMrWhoopeeEnter ( thePlayer, seat, jackedPlayer )
    outputChatBox ( getPlayerName ( thePlayer ) .. " stole the Whoopee!", root, 255, 0, 0 )
    -- create the marker to attach
    local arrowMarker = createMarker ( 0, 0, 0, "arrow", .75, 255, 0, 0, 170 )
    -- attach the marker to the player with a vertical offset of 2 units
    attachElements ( arrowMarker, thePlayer, 0, 0, 2 )
end


-- attach it to an event
addEventHandler ( "onVehicleEnter", vehicleMrWhoopee, onMrWhoopeeEnter )

See Also

Element Functions
Element Events
Reference