Pair: getElementModel

Manual Review Required

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

---

Sets the model of a given element. This allows you to change the model of a player (or ped), a vehicle or an object.

OOP Syntax Help! I don't understand this!

• Method:element:setModel(...)
• Variable: .model

Syntax

bool setElementModel ( element theElement, int model )

Required Arguments

• theElement: the element you want to change.
• model: the model ID to set. For players/peds: A GTASA player model (skin) ID. See Character Skins . For vehicles: The vehicle ID of the vehicle being changed. For objects/projectiles/weapons: An int specifying the model id.

Returns

• bool: value

Returns true if successful, false otherwise.

Code Examples

Example 1 Example 2

shared

This example allows players to change their own skin with a command (/skin [ID])

local spam = {}

function setSkin(player, cmd, skin)
    if spam[player] and getTickCount() - spam[player] < 4000 then
        return outputChatBox("You cannot change skin that often!", player, 255, 0, 0)
    end

    skin = skin and tonumber(skin)

    if getElementModel(player) == skin or isPedDead(player) then
        return
    end

    if skin and skin <= 99999 then -- what do we know about dynamic ped ID range?
        setElementModel(player, skin)
        spam[player] = getTickCount()
    else
        outputChatBox("Invalid skin ID!", player, 255, 0, 0)
    end
end
addCommandHandler("skin", setSkin)

function cleanUp()
    if spam[source] then
        spam[source] = nil
    end
end
addEventHandler("onPlayerQuit", root, cleanUp)

shared

This example allows players to transform their current vehicle into another vehicle model.

local spam = {}

function changeMyVehicle(player, command, newModel)
  if spam[player] and getTickCount() - spam[player] < 2500 then
    return outputChatBox("Don't spam vehicle changes!", player, 255, 0, 0)
  end

  local theVehicle = getPedOccupiedVehicle(player)

  if not (theVehicle and getVehicleController(theVehicle) == player) then
    return outputChatBox("You must be driving a vehicle in order to change it!", player, 255, 0, 0)
  end

  if isValidModel(newModel) and isElement(theVehicle) then
    setElementModel(theVehicle, newModel)
    spam[player] = getTickCount()
  else
    outputChatBox("Invalid vehicle ID!", player, 255, 0, 0)
  end
end
addCommandHandler("changeveh", changeMyVehicle)

function isValidModel(modelID)
  modelID = tonumber(modelID)
  if modelID and modelID >= 400 and modelID <= 611 then
    return true
  end
  return false
end

function cleanUp()
  if spam[source] then
    spam[source] = nil
  end
end
addEventHandler("onPlayerQuit", root, cleanUp)

See Also

Element Functions

• addElementDataSubscriber
• attachElements
• clearElementVisibleTo
• cloneElement
• createElement
• destroyElement
• detachElements
• getAllElementData
• getAttachedElements
• getElementAlpha
• getElementAngularVelocity
• getElementAttachedOffsets
• getElementAttachedTo
• getElementBonePosition
• getElementBoneQuaternion
• getElementBoneRotation
• getElementBoundingBox
• getElementByID
• getElementByIndex
• getElementChild
• getElementChildren
• getElementChildrenCount
• getElementCollisionsEnabled
• getElementColShape
• getElementData
• getElementDimension
• getElementDistanceFromCentreOfMassToBaseOfModel
• getElementHealth
• getElementID
• getElementInterior
• getElementLighting
• 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
• isElementOnFire
• isElementOnScreen
• isElementStreamable
• isElementStreamedIn
• isElementSyncer
• isElementVisibleTo
• isElementWaitingForGroundToLoad
• isElementWithinColShape
• isElementWithinMarker
• removeElementData
• removeElementDataSubscriber
• setElementAlpha
• setElementAngularVelocity
• setElementAttachedOffsets
• setElementBonePosition
• setElementBoneQuaternion
• setElementBoneRotation
• setElementCallPropagationEnabled
• setElementCollidableWith
• setElementCollisionsEnabled
• setElementData
• setElementDimension
• setElementDoubleSided
• setElementFrozen
• setElementHealth
• setElementID
• setElementInterior
• setElementLighting
• setElementModel
• setElementOnFire
• 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