Skip to content

Precache

scripts/vscripts/alyxlib/precache.lua

Functions

GlobalPrecache

Add an asset to be precached when the player spawns.

If you are precaching after the player has spawned, then you must also call GlobalPrecacheFlush.

GlobalPrecache(type, path, spawnkeys)

Parameters

  • type
    AlyxLibGlobalPrecacheType
    The type of asset to precache.
  • path
    string
    The asset path to precache (or the classname if type is entity).
  • spawnkeys
    table?
    The spawnkeys table if type is entity.

GlobalPrecacheFlush

Flushes the global precache list and precaches the assets.

This is an asynchronous process; the assets will not be immediately available after calling this function.

If you are precaching after the player has spawned, call this function after preceding GlobalPrecache calls.

GlobalPrecacheFlush(callback)

Parameters

  • callback (optional)
    function
    The function to call when the precaching is complete.

_PrecacheGlobalItems

Internal function used to start the precache process.

This should only be called manually if you know what you're doing!

_PrecacheGlobalItems(context)

Parameters

  • context
    CScriptPrecacheContext

Types

A

Field Type Description
type AlyxLibGlobalPrecacheType The type of asset to precache.
path string The asset path to precache (or the classname if type is entity).
spawnkeys table? The spawnkeys table if type is entity.

Aliases

AlyxLibGlobalPrecacheType

Value Description
"model_folder"
"sound"
"soundfile"
"particle"
"particle_folder"
"model"
"entity"