Manual Review Required

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

---

This function sets a custom LOD distance for any object / model ID. This is the distance at which objects of that model ID are switched to their LOD model, or (if there is no LOD model) become invisible.

OOP Syntax Help! I don't understand this!

• Method: Engine.setModelLODDistance(...)

Syntax

bool engineSetModelLODDistance ( int model, float distance, [ bool extendedLod = false ] )

Required Arguments

• model: The model / object ID number you want to change the LOD distance of.
• distance: New LOD distance value in San Andreas units.

Optional Arguments

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

• extendedLod (default: false): MISSING_PARAM_DESC

Returns

• bool: value

Returns true if the function executed succesfully, false otherwise.

Code Examples

Example 1 Example 2 Example 3

shared

This example will set the LOD distance of all script-created objects.

-- Client-side
-- WARNING: Can cause significant lag.

-- Adjusts LOD for all objects.
function setAllObjectsLOD()

    -- Get all current objects.
    local objects = getElementsByType("object", root, false)

    for _, theObject in ipairs(objects) do

        local modelID = getElementModel(theObject)
        local lodLevel = 325 -- Distance value

        -- Set LOD for this model ID.
        -- The 'true' enables extended range.
        engineSetModelLODDistance(modelID, lodLevel, true)

    end
end

-- Command to run the function.
addCommandHandler("setAllObjectsLOD", setAllObjectsLOD)

shared

This example will, besides replacing with custom map objects, also set the LOD distance accordingly, a necessary step (otherwise the object could seem to fail loading and only show up 1 feet away).

function replaceObjects()

  local col1 = engineLoadCOL("map1.col")
  local col2 = engineLoadCOL("map2.col")

  local txd = engineLoadTXD("map.txd")
  engineImportTXD(txd, 2357)
  engineImportTXD(txd, 2290)

  local dff1 = engineLoadDFF("map1.dff")
  local dff2 = engineLoadDFF("map2.dff")

  engineReplaceCOL(col1, 2357)
  engineReplaceCOL(col2, 2290)
  engineReplaceModel(dff1, 2357)
  engineReplaceModel(dff2, 2290)

  engineSetModelLODDistance(2357, 325)
  engineSetModelLODDistance(2290, 325)
end

shared

This example shows how to use LOD's with buildings.

function createMyPyramid()
    local pos = Vector3(0, 0, 3)
    local rot = Vector3(0, 0, 0)

    local modelHi = 8395  -- This model has a lot of polygons
    local modelLow = 8701 -- This model is optimized for drawing at a long distance

    -- Always call this function if you don't like default draw distance
    -- or you allocated the model with using engineRequestModel
    engineSetModelLODDistance(modelHi, 100, true)
    engineSetModelLODDistance(modelLow, 500, true)

    local lod = createBuilding(modelLow, pos, rot)
    local building = createBuilding(modelHi, pos, rot)

    setLowLODElement(building,lod)
end

See Also

Engine Functions

• engineAddClothingModel
• engineAddClothingTXD
• engineAddImage
• engineApplyShaderToWorldTexture
• engineFreeModel
• engineFreeTXD
• engineGetModelFlags
• engineGetModelIDFromName
• engineGetModelLODDistance
• engineGetModelNameFromID
• engineGetModelPhysicalPropertiesGroup
• engineGetModelTextureNames
• engineGetModelTextures
• engineGetModelTXDID
• engineGetModelVisibleTime
• engineGetObjectGroupPhysicalProperty
• engineGetPoolCapacity
• engineGetPoolDefaultCapacity
• engineGetPoolUsedCapacity
• engineGetSurfaceProperties
• engineGetVisibleTextureNames
• engineImageGetFile
• engineImageGetFiles
• engineImageGetFilesCount
• engineImageLinkDFF
• engineImageLinkTXD
• engineImportTXD
• engineLoadCOL
• engineLoadDFF
• engineLoadIFP
• engineLoadIMG
• engineLoadTXD
• enginePreloadWorldArea
• engineRemoveImage
• engineRemoveShaderFromWorldTexture
• engineReplaceAnimation
• engineReplaceCOL
• engineReplaceModel
• engineRequestModel
• engineRequestTXD
• engineResetModelFlags
• engineResetModelLODDistance
• engineResetModelTXDID
• engineResetSurfaceProperties
• engineRestoreAnimation
• engineRestoreCOL
• engineRestoreDFFImage
• engineRestoreModel
• engineRestoreModelPhysicalPropertiesGroup
• engineRestoreObjectGroupPhysicalProperties
• engineRestoreTXDImage
• engineRestreamWorld
• engineSetAsynchronousLoading
• engineSetModelFlag
• engineSetModelFlags
• engineSetModelLODDistance
• engineSetModelPhysicalPropertiesGroup
• engineSetModelTXDID
• engineSetModelVisibleTime
• engineSetObjectGroupPhysicalProperty
• engineSetPoolCapacity
• engineSetSurfaceProperties
• engineStreamingFreeUpMemory
• engineStreamingGetBufferSize
• engineStreamingGetMemorySize
• engineStreamingGetModelLoadState
• engineStreamingGetUsedMemory
• engineStreamingReleaseModel
• engineStreamingRequestModel
• engineStreamingRestoreBufferSize
• engineStreamingRestoreMemorySize
• engineStreamingSetBufferSize
• engineStreamingSetMemorySize
• engineStreamingSetModelCacheLimits

Engine Elements

• col
• dff
• txd

Reference

• Scripting Functions