Pair: detachElements

This function attaches one element to another, so that the first one follows the second whenever it moves. Supported element types are ped, player, blip, vehicle, object, marker, pickup, sound, colshape, weapon, camera, light.

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).
• If an attempt is made to attach two elements that are already attached the opposite way (eg theElement becomes theAttachToElement and vice versa), the 1st attachment order is automatically detached in favor of the 2nd attachment order. For example, if carA was attached to carB, now carB is attached to carA. Also, an element cannot be attached to two separate elements at one time. For example, two cars can be attached to one single car, but one single car cannot be attached to two separate cars. If you attempt to do this, the existing attachment will automatically be dropped in favor of the new attachment. For example, if carA is asked to attached to carB then carC, it is only attached to carC.

OOP Syntax Help! I don't understand this!

• Note: The variable can only be used if the offsets can be 0 (use setElementAttachedOffsets).

• Method:element:attach(...)
• Variable: .attachedTo

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.
• yPosOffset (default: 0): The Y offset.
• zPosOffset (default: 0): The Z offset.
• xRotOffset (default: 0): The X rotation offset.
• yRotOffset (default: 0): The Y rotation offset.
• zRotOffset (default: 0): The Z rotation offset.

Returns

• bool: result

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

Code Examples

Example 1 Example 2 Example 3 (OOP) Example 4 Example 5 (OOP)

shared

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)

shared

This function adds a tank on top of a player (for extra defense).

function tankHat(source, commandName)
    local x, y, z = getElementPosition(source) -- Get the players position
    local tank = createVehicle(432, x, y, z + 5) -- Create a tank
    attachElements(tank, source, 0, 0, 5) -- Attach the tank to the player.
end
addCommandHandler("hat", tankHat)

shared

OOP Required

This function adds a tank on top of a player (for extra defense).

function tankHat(source, commandName)
    local pos = source.position -- Get the players position
    local tank = Vehicle(432, pos.x, pos.y, pos.z + 5) -- Create a tank
    tank:attach(source, 0, 0, 5) -- Attach the tank to the player.
end
addCommandHandler("hat", tankHat)

client

This function adds a tank on top of a player (for extra defense), clientside. This means it will be invisible to other players.

function tankHat(commandName)
    local x,y,z = getElementPosition(localPlayer) -- Get the players position
    local tank = createVehicle(432, x, y, z + 5) -- Create a tank
    attachElements(tank, localPlayer, 0, 0, 5) -- Attach the tank to the player.
end
addCommandHandler("hat", tankHat)

client

OOP Required

local obj = Object(1337, 0, 0, 0)
obj.attachedTo = localPlayer -- or localPlayer:attach(obj)

obj:setAttachedOffsets(0.3, 0.1, 0.25, 0, 0, 0)

See Also

Element Functions

• addElementDataSubscriber
• attachElements
• clearElementVisibleTo
• cloneElement
• createElement
• destroyElement
• detachElements
• getAllElementDataUpdated
• getAttachedElements
• getElementAlpha
• getElementAngularVelocity
• getElementAttachedOffsets
• getElementAttachedTo
• getElementBonePosition
• getElementBoneQuaternionNew
• getElementBoneRotation
• getElementBoundingBox
• getElementByID
• getElementByIndex
• getElementChild
• getElementChildren
• getElementChildrenCount
• getElementCollisionsEnabled
• getElementColShape
• getElementData
• getElementDimension
• getElementDistanceFromCentreOfMassToBaseOfModel
• getElementHealth
• getElementID
• getElementInterior
• getElementLighting
• getElementMatrix
• getElementModel
• getElementParent
• getElementPosition
• getElementRadius
• getElementRotation
• getElementsByType
• getElementsWithinColShape
• getElementsWithinRange
• getElementSyncer
• getElementType
• getElementVelocity
• getElementZoneName
• getLowLODElement
• getRootElement
• hasElementData
• hasElementDataSubscriber
• isElement
• isElementAttached
• isElementCallPropagationEnabled
• isElementCollidableWith
• isElementDoubleSided
• isElementFrozen
• isElementInWater
• isElementLocal
• isElementLowLOD
• isElementOnFireNew
• isElementOnScreen
• isElementStreamable
• isElementStreamedIn
• isElementSyncer
• isElementVisibleTo
• isElementWaitingForGroundToLoad
• isElementWithinColShape
• isElementWithinMarker
• removeElementData
• removeElementDataSubscriber
• setElementAlpha
• setElementAngularVelocity
• setElementAttachedOffsets
• setElementBonePosition
• setElementBoneQuaternionNew
• setElementBoneRotation
• setElementCallPropagationEnabled
• setElementCollidableWith
• setElementCollisionsEnabled
• setElementDataUpdated
• setElementDimension
• setElementDoubleSided
• setElementFrozen
• setElementHealth
• setElementID
• setElementInterior
• setElementLightingNew
• setElementMatrix
• setElementModel
• setElementOnFireNew
• setElementParent
• setElementPosition
• setElementRotation
• setElementStreamable
• setElementSyncer
• setElementVelocity
• setElementVisibleTo
• setLowLODElement
• updateElementRpHAnim

Element Events

• onClientElementColShapeHit
• onClientElementColShapeLeave
• onClientElementDataChange
• onClientElementDestroy
• onClientElementDimensionChange
• onClientElementInteriorChange
• onClientElementModelChange
• onClientElementStreamIn
• onClientElementStreamOut
• onElementClicked
• onElementColShapeHit
• onElementColShapeLeave
• onElementDataChange
• onElementDestroy
• onElementDimensionChange
• onElementInteriorChange
• onElementModelChange
• onElementStartSync
• onElementStopSync

Reference

• Scripting Functions