Pair: getLowLODElement

Manual Review Required

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

---

This function assigns a low LOD element to an element. The low LOD element is displayed when its associated element is not fully visible. If a low LOD element is assigned to several elements, it will be displayed when any of these elements are not fully visible.

Note

The only valid elements types for assigning LODs with this function are Object and Building .

OOP Syntax Help! I don't understand this!

• Method:element:setLowLOD(...)
• Variable: .lowLOD

Syntax

bool setLowLODElement ( element theElement, element lowLODElement )

Required Arguments

• theElement: The element whose low LOD version we want to change.
• lowLODElement: MISSING_PARAM_DESC

Returns

• bool: value

Returns true if the assignment was successful, false otherwise.

Code Examples

Example 1 Example 2 Example 3

shared

This example shows how to create and link a normal and low LOD object:

-- Create a normal object
    local objNormal = createObject ( 3620, x,y,z,0,0,0 )

    -- Create a low LOD object
    local objLowLOD = createObject ( 5154, x,y,z,0,0,0,true )

    -- Assign the LOD object with the Normal object
    setLowLODElement ( objNormal, objLowLOD )
    -- Set the LOD object's parent to the Normal object so it is destroyed together
    setElementParent( objLowLOD, objNormal )

    -- Set the draw distance for the model we are using for low LOD to maximum
    engineSetModelLODDistance ( 5154, 300 )

shared

This example shows how to create and link a composite object

-- Create composite object
    objMainBit = createObject ( 3620, x,y,z )
    objLeftBit = createObject ( 5158, x,y,z )
    objRightBit = createObject ( 5158, x,y,z )
    objDetailBit1 = createObject ( 1337, x,y,z )
    objDetailBit2 = createObject ( 1337, x,y,z )
    objInternalBit = createObject ( 1337, x,y,z )
    attachElements ( objLeftBit, objMainBit, -10, 0, 0 )
    attachElements ( objRightBit, objMainBit, 10, 0, 0 )
    attachElements ( objDetailBit1, objMainBit, 5, 0, 0 )
    attachElements ( objDetailBit2, objLeftBit, 5, 5, 0 )
    attachElements ( objInternalBit, objRightBit, 5, 7, 0 )

    -- Create low LOD object (which represents the whole composite model)
    objlowLOD = createObject ( 5154, x,y,z, 0, 0, 0, true )

    -- Attach low LOD object so it moves with the main model
    attachElements ( objlowLOD, objMainBit, 0, 0, 0 )

    -- Set the low LOD object's parent to the main object so it is destroyed together
    setElementParent( objLowLOD, objMainBit )

    -- Set associations so the low LOD model is displayed when the main parts are not full visible
    setLowLODElement ( objMainBit, objlowLOD )
    setLowLODElement ( objLeftBit, objlowLOD )
    setLowLODElement ( objRightBit, objlowLOD )

    -- Note that the detail and internal parts have not been associated to the low LOD object

    -- Set the draw distance for the model we are using for low LOD to maximum
    triggerClientEvent("onClientChangeModelLODDistance", resourceRoot, 5154, 300 )

shared

Changing the draw distance for a model has to be done on the client:

addEvent("onClientChangeModelLODDistance",true)
addEventHandler("onClientChangeModelLODDistance", resourceRoot,
    function(model,distance)
        engineSetModelLODDistance ( model, distance )
    end
)

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