Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
ribbon Class Reference

#include <LUA_API_Ribbon.h>

Public Member Functions

void ribbon setDefaults ()
 Ribbon set defaults. More...
 
void ribbon create ()
 Ribbon create. More...
 
void ribbon destroy ()
 Ribbon destroy. More...
 
void ribbon timeOut ()
 Ribbon timeout. More...
 
void ribbon setPosition ()
 Ribbon set position. More...
 
void ribbon getPosition ()
 Ribbon get position. More...
 
void ribbon setTrailLength ()
 Ribbon set trail length. More...
 
void ribbon setRenderQueue ()
 Ribbon set render queue. More...
 
void ribbon setMaxElements ()
 Ribbon set maximum elements. More...
 
void ribbon setNumOfChains ()
 Ribbon set number of chains. More...
 
void ribbon setWidth ()
 Ribbon set width. More...
 
void ribbon setWidthRemovePerSec ()
 Ribbon set width remove per sec. More...
 
void ribbon setRenderDistance ()
 Ribbon set renderer distance. More...
 
void ribbon setFaceCamera ()
 Ribbon set face camera. More...
 
void ribbon setIsVisible ()
 Ribbon set is invisible. More...
 
void ribbon setCastShadows ()
 Ribbon set cast shadows. More...
 
void ribbon setInitialColour ()
 Ribbon set initial colour. More...
 
void ribbon setFadeColour ()
 Ribbon set fade colour. More...
 
void ribbon setNormalVector ()
 Ribbon set normal vector. More...
 
void ribbon setUseTexCoords ()
 Ribbon set use tex coordinates. More...
 
void ribbon setMaterialName ()
 Ribbon set material name. More...
 
void ribbon setDepthBias ()
 Ribbon set depth bias. More...
 
void ribbon setOpacity ()
 Ribbon set opacity. More...
 
void ribbon setDiffuseTexture ()
 Ribbon set diffuse texture. More...
 
void ribbon setRenderBackface ()
 Ribbon set back face. More...
 
void ribbon setEmissiveAmt ()
 Ribbon set emissive amount. More...
 
void ribbon setTexAddressMode ()
 Ribbon tex address mode. More...
 
void ribbon setTexFiltering ()
 Ribbon tex filtering. More...
 
void ribbon setSceneBlend ()
 Ribbon set scene blend. More...
 
void ribbon setScrollEnable ()
 Ribbon set scroll enable. More...
 
void ribbon setScrollAmount ()
 Ribbon set scroll amount. More...
 
void ribbon setRotateEnable ()
 Ribbon set rotate enable. More...
 
void ribbon setRotateSpeed ()
 Ribbon set rotate speed. More...
 
void ribbon setLighting ()
 Ribbon set lighting. More...
 

Detailed Description

This area covers navmesh functions. Set or get various navmesh propertie.
Use as navmesh.function()
This is to control the ribbon trails that can be attached to entity
Used on features such as tracers, vehicle treadmarks etc..

For more information on how these functions can be used please visit the User Manual - http://www.aurasoft-skyline.co.uk

Member Function Documentation

void ribbon ribbon::create ( )

Ribbon create.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::destroy ( )

Ribbon destroy.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::getPosition ( )

Ribbon get position.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setCastShadows ( )

Ribbon set cast shadows.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setDefaults ( )

Ribbon set defaults.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setDepthBias ( )

Ribbon set depth bias.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setDiffuseTexture ( )

Ribbon set diffuse texture.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setEmissiveAmt ( )

Ribbon set emissive amount.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setFaceCamera ( )

Ribbon set face camera.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setFadeColour ( )

Ribbon set fade colour.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setInitialColour ( )

Ribbon set initial colour.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setIsVisible ( )

Ribbon set is invisible.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setLighting ( )

Ribbon set lighting.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setMaterialName ( )

Ribbon set material name.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setMaxElements ( )

Ribbon set maximum elements.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setNormalVector ( )

Ribbon set normal vector.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setNumOfChains ( )

Ribbon set number of chains.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setOpacity ( )

Ribbon set opacity.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setPosition ( )

Ribbon set position.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setRenderBackface ( )

Ribbon set back face.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setRenderDistance ( )

Ribbon set renderer distance.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setRenderQueue ( )

Ribbon set render queue.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setRotateEnable ( )

Ribbon set rotate enable.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setRotateSpeed ( )

Ribbon set rotate speed.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setSceneBlend ( )

Ribbon set scene blend.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setScrollAmount ( )

Ribbon set scroll amount.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setScrollEnable ( )

Ribbon set scroll enable.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setTexAddressMode ( )

Ribbon tex address mode.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setTexFiltering ( )

Ribbon tex filtering.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setTrailLength ( )

Ribbon set trail length.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setUseTexCoords ( )

Ribbon set use tex coordinates.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setWidth ( )

Ribbon set width.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::setWidthRemovePerSec ( )

Ribbon set width remove per sec.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end
void ribbon ribbon::timeOut ( )

Ribbon timeout.

Parameters
property: Value Description

Here is a Small Example of how to use this function:

function onInit(objID)
    -- Enter example here
end

The documentation for this class was generated from the following file: