Module Photon.AirEL

AirEl Client Handler.

Info:

  • Copyright: Photon Team
  • Release: v74 Hot Sulphur Springs
  • Author: Photon Team

Functions

Photon.AirEL.DownloadMaterial(id, unitString, ent[, cback[, failed]]) Download a given material and apply it to a given entity.
Photon.AirEL.FormatName(id, unitString) Get an AirEL formatted material name.
Photon.AirEL.LoadMaterial(id, unitString, ent) Load a material from the cache or download it if it doesn't exist.
Photon.AirEL.LoadCallbackSuccess(id, unitString, ent) Callback function called when a texture is done downloading.
Photon.AirEL.LoadCallbackFail(error) Error callback function.
Photon.AirEL.ApplyTexture(mat, ent, id, unitString) Apply a texture to an ariel system.
Photon.AirEL.LoadMaterialFromFile(id, unitString) Load a material from a file.
Photon.AirEL.Apply(unitString, ent) Apply an AirEL skin to an entity.
Photon.AirEL.Scan() Scan function called to apply materials on AirEL entities.
Photon.AirEL.IllumScan() Scan function called to set on vs off illumination for AirEL entities.

Tables

Photon.AirEL.TranslationTable Translation between models and remote materials.
Photon.AirEL.TranslationTableIndex Translation between models and material indexes.
Photon.AirEL.MaterialIndex Table for storing materials, keyed by material name.


Functions

Methods
Photon.AirEL.DownloadMaterial(id, unitString, ent[, cback[, failed]])
Download a given material and apply it to a given entity.

Parameters:

  • id string Vehicle ID to download for.
  • unitString string Unit ID to apply to the texture.
  • ent Entity Entity to apply the downloaded texture to.
  • cback function Callback function to call once the material's been downloaded. (optional)
  • failed function Error callback if the HTTP query fails. (optional)
Photon.AirEL.FormatName(id, unitString)
Get an AirEL formatted material name.

Parameters:

Returns:

    string Formatted name.
Photon.AirEL.LoadMaterial(id, unitString, ent)
Load a material from the cache or download it if it doesn't exist.

Parameters:

  • id string Vehicle ID.
  • unitString string Unit ID.
  • ent Entity Vehicle to load to.
Photon.AirEL.LoadCallbackSuccess(id, unitString, ent)
Callback function called when a texture is done downloading.

Parameters:

  • id string Vehicle ID.
  • unitString string Unit ID.
  • ent Entity Entity to apply to.
Photon.AirEL.LoadCallbackFail(error)
Error callback function.

Parameters:

  • error string The error which occured.
Photon.AirEL.ApplyTexture(mat, ent, id, unitString)
Apply a texture to an ariel system.

Parameters:

  • mat Material Material being applied.
  • ent Entity Entity to apply the texture to.
  • id string Vehicle ID
  • unitString string Unit ID.
Photon.AirEL.LoadMaterialFromFile(id, unitString)
Load a material from a file.

Parameters:

Returns:

    Material The loaded material.
Photon.AirEL.Apply(unitString, ent)
Apply an AirEL skin to an entity.

Parameters:

  • unitString string Unit name to apply.
  • ent Entity Entity to apply to.
Photon.AirEL.Scan()
Scan function called to apply materials on AirEL entities.
Photon.AirEL.IllumScan()
Scan function called to set on vs off illumination for AirEL entities.

Tables

Photon.AirEL.TranslationTable
Translation between models and remote materials.
Photon.AirEL.TranslationTableIndex
Translation between models and material indexes.
Photon.AirEL.MaterialIndex
Table for storing materials, keyed by material name.
generated by LDoc 1.5.0 Last updated 2023-08-22 12:06:54