setElementCollidableWith

Client-side

Server-side

Shared

This function can be used to set an element to collide with another element. An element with collisions disabled does not interact physically with the other element. This can be a player, ped, vehicle, object or weapon.

Note

If you want to completely disable an element's collisions, use setElementCollisionsEnabled.

OOP Syntax Help! I don't understand this!

Method:element:setCollidableWith(...)

Syntax

bool setElementCollidableWith ( element theElement, element withElement, bool enabled )

Required Arguments

theElement: The element which colliding you want to change.
withElement: The other element you wish the first entity to collide with.
enabled: A boolean to indicate whether elements should be able to collide with each other (true) or not (false).

Returns

bool: result

Returns true if the collisions were set succesfully, false otherwise.

Code Examples

client

function ghostmode_on()
    local playerVehicle = getPedOccupiedVehicle(localPlayer) -- Get the players vehicle
    if (playerVehicle) then -- Check the return value.
        for i, v in pairs(getElementsByType("vehicle")) do -- LOOP through all vehicles
            setElementCollidableWith(v, playerVehicle, false) -- Set the collison off with the other vehicles.
        end
        outputChatBox("You are now a Ghost")
    end
end
addCommandHandler("ghostmode", ghostmode_on) -- Add the /ghostmode Command.

setElementCollidableWith

OOP Syntax Help! I don't understand this!

Syntax

Required Arguments

Returns

Code Examples

See Also

Element Functions

Element Events

Reference