BlendELF, Lua API doc

BlendELF Lua API doc

This document contains all of the avaialable functions for the BlendELF Lua API.

BlendELF TYPES

float - a floating point value, like 0.25 or 7.24
double - same as a floating poit value but can store more decimals
int - a positive or negative integer value, like 40 or -2500
unsigned int - a positive integer value, like 21 or 60
bool - a truth value, like true or false
string - a string of characters, like "cat" or "MyEntity"
elf_vec2i - contains the integer attributes [x|y] which can be accessed by vec.x and vec.y
elf_vec2f - contains the floating point attributes [x|y] which can be accessed by vec.x and vec.y
elf_vec3f - contains the floating point attributes [x|y|z] which can be accessed by vec.x, vec.y and vec.z
elf_vec4f - contains the floating point attributes [x|y|z|w] which can be accessed by vec.x, vec.y, vec.z and vec.w
elf_color - contains the floating point attributes [r|g|b|a] which can be accessed by col.r, col.g, col.b and col.a
object - any BlendELF object other than the types listed above

TRUTH VALUES

The thruth value flags. Usually you can just use normal Lua true and false but there are some special cases.

elf.FALSE

elf.TRUE

NONE VALUE

elf.NONE

KEY CODES

The key codes used by elf.GetKeyState

elf.KEY_ESC

elf.KEY_F1

elf.KEY_F2

elf.KEY_F3

elf.KEY_F4

elf.KEY_F5

elf.KEY_F6

elf.KEY_F7

elf.KEY_F8

elf.KEY_F9

elf.KEY_F10

elf.KEY_F11

elf.KEY_F12

elf.KEY_UP

elf.KEY_DOWN

elf.KEY_LEFT

elf.KEY_RIGHT

elf.KEY_LSHIFT

elf.KEY_RSHIFT

elf.KEY_LCTRL

elf.KEY_RCTRL

elf.KEY_LALT

elf.KEY_RALT

elf.KEY_TAB

elf.KEY_ENTER

elf.KEY_BACKSPACE

elf.KEY_INSERT

elf.KEY_DEL

elf.KEY_PAGEUP

elf.KEY_PAGEDOWN

elf.KEY_HOME

elf.KEY_END

elf.KEY_KP_0

elf.KEY_KP_1

elf.KEY_KP_2

elf.KEY_KP_3

elf.KEY_KP_4

elf.KEY_KP_5

elf.KEY_KP_6

elf.KEY_KP_7

elf.KEY_KP_8

elf.KEY_KP_9

elf.KEY_KP_DIVIDE

elf.KEY_KP_MULTIPLY

elf.KEY_KP_SUBTRACT

elf.KEY_KP_ADD

elf.KEY_KP_DECIMAL

elf.KEY_KP_EQUAL

elf.KEY_KP_ENTER

elf.KEY_SPACE

elf.KEY_0

elf.KEY_1

elf.KEY_2

elf.KEY_3

elf.KEY_4

elf.KEY_5

elf.KEY_6

elf.KEY_7

elf.KEY_8

elf.KEY_9

elf.KEY_A

elf.KEY_B

elf.KEY_C

elf.KEY_D

elf.KEY_E

elf.KEY_F

elf.KEY_G

elf.KEY_H

elf.KEY_I

elf.KEY_J

elf.KEY_K

elf.KEY_L

elf.KEY_M

elf.KEY_N

elf.KEY_O

elf.KEY_P

elf.KEY_Q

elf.KEY_R

elf.KEY_S

elf.KEY_T

elf.KEY_U

elf.KEY_V

elf.KEY_W

elf.KEY_X

elf.KEY_Y

elf.KEY_Z

KEY AND MOUSE STATES

The state codes returned by elf.GetKeyState and elf.GetMouseButtonState

elf.UP

elf.PRESSED

elf.DOWN

elf.RELEASED

GUI BUTTON STATE

The gui button states returned by elf.GetButtonState

elf.OFF

elf.ON

elf.OVER

MOUSE BUTTON CODES

The mouse button codes used by elf.GetMouseButtonState

elf.BUTTON_LEFT

elf.BUTTON_MIDDLE

elf.BUTTON_RIGHT

ELF OBJECT TYEPS

The object types returned by elf.GetObjectType

elf.TEXTURE

elf.MATERIAL

elf.MODEL

elf.CAMERA

elf.ENTITY

elf.LIGHT

elf.SCENE

elf.LIST

elf.PAK

elf.PAK_INDEX

elf.KEY_EVENT

elf.CHAR_EVENT

elf.CONTEXT

elf.ENGINE

elf.TIMER

elf.IMAGE

elf.POST_PROCESS

elf.SCRIPT

elf.AUDIO_DEVICE

elf.AUDIO_SOURCE

elf.SOUND

elf.BONE

elf.ARMATURE

elf.STRING

elf.FONT

elf.LABEL

elf.BUTTON

elf.PICTURE

elf.TEXT_FIELD

elf.SLIDER

elf.SCREEN

elf.TEXT_LIST

elf.CHECK_BOX

elf.GUI

elf.DIRECTORY_ITEM

elf.DIRECTORY

elf.COLLISION

elf.PHYSICS_OBJECT

elf.PHYSICS_WORLD

elf.JOINT

elf.PARTICLE

elf.PARTICLES

elf.CONFIG

elf.BEZIER_POINT

elf.BEZIER_CURVE

elf.IPO

elf.FRAME_PLAYER

elf.PROPERTY

elf.CLIENT

elf.SCRIPTING

elf.PHYSICS_TRI_MESH

elf.SPRITE

elf.VIDEO_MODE

elf.GENERAL

elf.VERTICE

elf.FACE

elf.MESH_DATA

NUMBER OF OBJECT TYPES

elf.OBJECT_TYPE_COUNT

CAMERA MODE

The camera modes used by camera internal functions

elf.PERSPECTIVE

elf.ORTHOGRAPHIC

PHYSICS SHAPES

The physics shapes used by elf.SetEntityPhysics

elf.BOX

elf.SPHERE

elf.MESH

elf.CAPSULE_X

elf.CAPSULE_Y

elf.CAPSULE_Z

elf.CONE_X

elf.CONE_Y

elf.CONE_Z

JOINT TYPES

The joint types returned by elf.GetJointType

elf.HINGE

elf.BALL

elf.CONE_TWIST

LIGHT TYPES

The light types used by elf.SetLightType

elf.POINT_LIGHT

elf.SUN_LIGHT

elf.SPOT_LIGHT

TEXTURE FORMATS

The texture formats returned by elf.GetTextureFormat

elf.LUMINANCE

elf.LUMINANCE_ALPHA

elf.RGB

elf.RGBA

elf.BGR

elf.BGRA

elf.RGB16F

elf.RGB32F

elf.RGBA16F

elf.RGBA32F

elf.ALPHA32F

elf.DEPTH_COMPONENT

elf.COMPRESSED_RGB

elf.COMPRESSED_RGBA

TEXTURE DATA FORMATS

The texture formats returned by elf.GetTextureDataFormat

elf.FLOAT

elf.INT

elf.UINT

elf.SHORT

elf.USHORT

elf.BYTE

elf.UBYTE

PROPERTY TYPES

The property types returned by elf.GetPropertyType

elf.PROPERTY_INT

elf.PROPERTY_FLOAT

elf.PROPERTY_STRING

elf.PROPERTY_BOOL

TEXTURE TYPES

The textures types used by elf.SetMaterialTextureType

elf.COLOR_MAP

elf.NORMAL_MAP

elf.HEIGHT_MAP

elf.SPECULAR_MAP

elf.DETAIL_MAP

elf.SHADOW_MAP

elf.COLOR_RAMP_MAP

elf.LIGHT_MAP

PARTICLE DRAW MODES

The draw modes used by elf.SetParticlesDrawMode

elf.TRANSPARENT

elf.ADD

DIRECTORY ITEM TYPES

The directory item types used by elf.GetDirectoryItemType

elf.DIR

elf.FILE

GUI EVENTS

The gui events triggered by gui objects. The gui events are automatically set to the "event" variable when in a gui action.

elf.CLICKED

elf.VALUE_CHANGED

elf.GAIN_FOCUS

elf.LOSE_FOCUS

elf.CHAR_INPUT

elf.SELECTION_CHANGED

elf.STATE_CHANGED

JOYSTICK BUTTONS

The joystick buttons used by elf.GetJoystickButtonState

elf.JOYSTICK_BUTTON_1

elf.JOYSTICK_BUTTON_2

elf.JOYSTICK_BUTTON_3

elf.JOYSTICK_BUTTON_4

elf.JOYSTICK_BUTTON_5

elf.JOYSTICK_BUTTON_6

elf.JOYSTICK_BUTTON_7

elf.JOYSTICK_BUTTON_8

elf.JOYSTICK_BUTTON_9

elf.JOYSTICK_BUTTON_10

elf.JOYSTICK_BUTTON_11

elf.JOYSTICK_BUTTON_12

elf.JOYSTICK_BUTTON_13

elf.JOYSTICK_BUTTON_14

elf.JOYSTICK_BUTTON_15

elf.JOYSTICK_BUTTON_16

BEZIER CURVE TYPES

elf.LOC_X

elf.LOC_Y

elf.LOC_Z

elf.ROT_X

elf.ROT_Y

elf.ROT_Z

elf.SCALE_X

elf.SCALE_Y

elf.SCALE_Z

elf.QUA_X

elf.QUA_Y

elf.QUA_Z

elf.QUA_W

NETWORKING EVENTS

elf.NET_NONE

elf.NET_CONNECT

elf.NET_RECEIVE

elf.NET_DISCONNECT

SOUND FILE TYPES

The sound file types returned by elf.GetSoundFileType

elf.OGG

elf.WAV

ERROR CODES

error codes returned by elf.GetError

elf.NO_ERROR

elf.INVALID_FILE

elf.CANT_OPEN_FILE

elf.CANT_OPEN_DIRECTORY

elf.CANT_INITIALIZE

elf.CANT_RUN_STRING

elf.CANT_RUN_SCRIPT

elf.CANT_CREATE

elf.CANT_RESIZE

elf.INVALID_SIZE

elf.UNKNOWN_FORMAT

elf.UNKNOWN_TYPE

elf.INVALID_HANDLE

elf.MISSING_FEATURE

elf.INVALID_MESH

OBJECT FUNCTIONS

The object functions can be performed on any generic ELF objects.

int elf.GetObjectType( object obj )

int elf.GetObjectRefCount( object obj )

int elf.GetGlobalRefCount( )

int elf.GetGlobalObjCount( )

bool elf.IsActor( object obj )

bool elf.IsGuiObject( object obj )

LIST FUNCTIONS

object elf.CreateList( )

int elf.GetListLength( object list )

elf.InsertToList( object list, int idx, object obj )

elf.AppendToList( object list, object obj )

bool elf.RemoveFromList( object list, object obj )

object elf.GetItemFromList( object list, int idx )

object elf.BeginList( object list )

object elf.NextInList( object list )

object elf.RbeginList( object list )

object elf.RnextInList( object list )

elf.SeekList( object list, object ptr )

elf.RseekList( object list, object ptr )

CONFIGURATION FUNCTIONS

object elf.ReadConfig( string file_path )

int elf.GetConfigWindowWidth( object config )

int elf.GetConfigWindowHeight( object config )

bool elf.GetConfigFullscreen( object config )

bool elf.GetConfigTextureCompress( object config )

float elf.GetConfigTextureAnisotropy( object config )

int elf.GetConfigShadowMapSize( object config )

string elf.GetConfigStart( object config )

string elf.GetConfigLog( object config )

CONTEXT FUNCTIONS

elf.SetTitle( string title )

int elf.GetWindowWidth( )

int elf.GetWindowHeight( )

int elf.GetVideoModeCount( )

elf_vec2i elf.GetVideoMode( int idx )

bool elf.IsFullscreen( )

string elf.GetTitle( )

int elf.GetMultisamples( )

double elf.GetTime( )

bool elf.IsWindowOpened( )

elf_vec2i elf.GetMousePosition( )

elf_vec2i elf.GetMouseForce( )

elf.SetMousePosition( int x, int y )

elf.HideMouse( bool hide )

bool elf.IsMouseHidden( )

int elf.GetMouseWheel( )

int elf.GetMouseButtonState( int button )

int elf.GetKeyState( int key )

bool elf.GetJoystickPresent( int joy )

elf_vec2f elf.GetJoystickAxis( int joy )

int elf.GetJoystickButtonState( int joy, int but )

int elf.GetEventCount( )

object elf.GetEvent( int idx )

ENGINE FUNCTIONS

bool elf.Init( int width, int height, string title, bool fullscreen, string log )

bool elf.InitWithConfig( string file_path )

elf.Deinit( )

elf.ResizeWindow( int width, int height )

string elf.GetPlatform( )

int elf.GetVersionMajor( )

int elf.GetVersionMinor( )

string elf.GetVersionRelease( )

string elf.GetVersion( )

string elf.GetCurrentDirectory( )

string elf.GetErrorString( )

int elf.GetError( )

bool elf.Run( )

elf.Quit( )

elf.SetF10Exit( bool exit )

bool elf.GetF10Exit( )

object elf.LoadScene( string file_path )

elf.SetScene( object scene )

object elf.GetScene( )

elf.SetGui( object gui )

object elf.GetGui( )

float elf.GetSync( )

int elf.GetFps( )

bool elf.SaveScreenShot( string file_path )

elf.SetFpsLimit( int fps_limit )

int elf.GetFpsLimit( )

elf.SetTickRate( float tick_rate )

float elf.GetTickRate( )

elf.SetSpeed( float speed )

float elf.GetSpeed( )

elf.SetTextureCompress( bool compress )

bool elf.GetTextureCompress( )

elf.SetTextureAnisotropy( float anisotropy )

float elf.GetTextureAnisotropy( )

elf.SetShadowMapSize( int size )

int elf.GetShadowMapSize( )

int elf.GetPolygonsRendered( )

elf.SetBloom( float threshold )

elf.DisableBloom( )

float elf.GetBloomThreshold( )

elf.SetDof( float focal_range, float focal_distance )

elf.DisableDof( )

float elf.GetDofFocalRange( )

float elf.GetDofFocalDistance( )

elf.SetSsao( float amount )

elf.DisableSsao( )

float elf.GetSsaoAmount( )

elf.SetLightShafts( float intensity )

elf.DisableLightShafts( )

float elf.GetLightShaftsInteisity( )

bool elf.IsBloom( )

bool elf.IsSsao( )

bool elf.IsDof( )

bool elf.IsLightShafts( )

elf.SetOcclusionCulling( bool cull )

bool elf.IsOcclusionCulling( )

elf.SetDebugDraw( bool debug_draw )

bool elf.IsDebugDraw( )

object elf.GetActor( )

object elf.ReadDirectory( string path )

string elf.GetDirectoryPath( object directory )

int elf.GetDirectoryItemCount( object directory )

object elf.GetDirectoryItem( object directory, int idx )

string elf.GetDirectoryItemName( object dir_item )

int elf.GetDirectoryItemType( object dir_item )

elf_vec3f elf.CreateVec3f( )

elf_vec3f elf.CreateVec3fFromValues( float x, float y, float z )

elf_vec4f elf.CreateQua( )

elf_vec4f elf.CreateQuaFromEuler( float x, float y, float z )

elf_vec4f elf.CreateQuaFromAngleAxis( float angle, float x, float y, float z )

elf_vec3f elf.MulQuaVec3f( elf_vec4f qua, elf_vec3f vec )

elf_vec4f elf.MulQuaQua( elf_vec4f qua1, elf_vec4f qua2 )

elf_vec4f elf.GetQuaInverted( elf_vec4f qua )

elf_vec3f elf.RotateVec3f( elf_vec3f vec, float x, float y, float z )

elf_vec3f elf.SubVec3fVec3f( elf_vec3f vec1, elf_vec3f vec2 )

elf_vec3f elf.AddVec3fVec3f( elf_vec3f vec1, elf_vec3f vec2 )

float elf.GetVec3fLength( elf_vec3f vec )

bool elf.AboutZero( float val )

float elf.FloatAbs( float val )

float elf.FloatMin( float a, float b )

float elf.FloatMax( float a, float b )

float elf.RandomFloat( )

float elf.RandomFloatRange( float min, float max )

int elf.RandomInt( )

int elf.RandomIntRange( int min, int max )

FRAME PLAYER FUNCTIONS

object elf.CreateFramePlayer( )

elf.UpdateFramePlayer( object player )

elf.SetFramePlayerFrame( object player, float frame )

elf.PlayFramePlayer( object player, float start, float end, float speed )

elf.LoopFramePlayer( object player, float start, float end, float speed )

elf.StopFramePlayer( object player )

elf.PauseFramePlayer( object player )

elf.ResumeFramePlayer( object player )

float elf.GetFramePlayerStart( object player )

float elf.GetFramePlayerEnd( object player )

float elf.GetFramePlayerSpeed( object player )

float elf.GetFramePlayerFrame( object player )

bool elf.IsFramePlayerPlaying( object player )

bool elf.IsFramePlayerPaused( object player )

TIMER FUNCTIONS

object elf.CreateTimer( )

elf.StartTimer( object timer )

double elf.GetElapsedTime( object timer )

IMAGE FUNCTIONS

object elf.CreateEmptyImage( int width, int height, int bpp )

object elf.CreateImageFromFile( string file_path )

elf.SetImagePixel( object image, int x, int y, float r, float g, float b, float a )

int elf.GetImageWidth( object image )

int elf.GetImageHeight( object image )

int elf.GetImageBitsPerPixel( object image )

elf_color elf.GetImagePixel( object image, int x, int y )

TEXTURE FUNCTIONS

object elf.CreateTextureFromFile( string file_path )

object elf.CreateTextureFromImage( object image )

elf.SetTextureName( object texture, string name )

string elf.GetTextureName( object texture )

string elf.GetTextureFilePath( object texture )

int elf.GetTextureWidth( object texture )

int elf.GetTextureHeight( object texture )

int elf.GetTextureFormat( object texture )

int elf.GetTextureDataFormat( object texture )

MATERIAL FUNCTIONS

object elf.CreateMaterial( string name )

elf.SetMaterialDiffuseColor( object material, float r, float g, float b, float a )

elf.SetMaterialSpecularColor( object material, float r, float g, float b, float a )

elf.SetMaterialAmbientColor( object material, float r, float g, float b, float a )

elf.SetMaterialSpecularPower( object material, float power )

elf.SetMaterialLighting( object material, bool lighting )

elf.SetMaterialName( object material, string name )

string elf.GetMaterialName( object material )

string elf.GetMaterialFilePath( object material )

elf_color elf.GetMaterialDiffuseColor( object material )

elf_color elf.GetMaterialSpecularColor( object material )

elf_color elf.GetMaterialAmbientColor( object material )

float elf.GetMaterialSpecularPower( object material )

bool elf.GetMaterialLighting( object material )

elf.SetMaterialDiffuseMap( object material, object texture )

elf.SetMaterialNormalMap( object material, object texture )

elf.SetMaterialHeightMap( object material, object texture )

elf.SetMaterialSpecularMap( object material, object texture )

elf.SetMaterialLightMap( object material, object texture )

elf.ClearMaterialDiffuseMap( object material )

elf.ClearMaterialNormalMap( object material )

elf.ClearMaterialHeightMap( object material )

elf.ClearMaterialSpecularMap( object material )

elf.ClearMaterialLightMap( object material )

object elf.GetMaterialDiffuseMap( object material )

object elf.GetMaterialNormalMap( object material )

object elf.GetMaterialHeightMap( object material )

object elf.GetMaterialSpecularMap( object material )

object elf.GetMaterialLightMap( object material )

elf.SetMaterialParallaxScale( object material, float scale )

elf.SetMaterialAlphaTest( object material, bool alpha_test )

elf.SetMaterialAlphaThreshold( object material, float threshold )

float elf.GetMaterialParallaxScale( object material )

bool elf.GetMaterialAlphaTest( object material )

float elf.GetMaterialAlphaThreshold( object material )

elf.AddPointToBezierCurve( object curve, object point )

bool elf.AddCurveToIpo( object ipo, object curve )

elf_vec3f elf.GetIpoLoc( object ipo, float x )

elf_vec3f elf.GetIpoRot( object ipo, float x )

elf_vec3f elf.GetIpoScale( object ipo, float x )

elf_vec4f elf.GetIpoQua( object ipo, float x )

object elf.CreateProperty( string name )

int elf.GetPropertyType( object property )

int elf.GetPropertyInt( object property )

float elf.GetPropertyFloat( object property )

string elf.GetPropertyString( object property )

bool elf.GetPropertyBool( object property )

elf.SetPropertyInt( object property, int ival )

elf.SetPropertyFloat( object property, float fval )

elf.SetPropertyString( object property, string sval )

elf.SetPropertyBool( object property, bool bval )

ACTOR FUNCTIONS

Actor functions can be performed on all actor types. [Camera|Entity|Light|Armature]

string elf.GetActorName( object actor )

string elf.GetActorFilePath( object actor )

object elf.GetActorScript( object actor )

elf.SetActorName( object actor, string name )

elf.SetActorScript( object actor, object script )

elf.ClearActorScript( object actor )

elf.SetActorPosition( object actor, float x, float y, float z )

elf.SetActorRotation( object actor, float x, float y, float z )

elf.SetActorOrientation( object actor, float x, float y, float z, float w )

elf.RotateActor( object actor, float x, float y, float z )

elf.RotateActorLocal( object actor, float x, float y, float z )

elf.MoveActor( object actor, float x, float y, float z )

elf.MoveActorLocal( object actor, float x, float y, float z )

elf.SetActorPositionRelativeTo( object actor, object to, float x, float y, float z )

elf.SetActorRotationRelativeTo( object actor, object to, float x, float y, float z )

elf.SetActorOrientationRelativeTo( object actor, object to, float x, float y, float z, float w )

elf_vec3f elf.GetActorPosition( object actor )

elf_vec3f elf.GetActorRotation( object actor )

elf_vec4f elf.GetActorOrientation( object actor )

elf.SetActorBoundingLengths( object actor, float x, float y, float z )

elf.SetActorBoundingOffset( object actor, float x, float y, float z )

elf.SetActorPhysics( object actor, int shape, float mass )

bool elf.IsActorPhysics( object actor )

elf.DisableActorPhysics( object actor )

elf.SetActorDamping( object actor, float lin_damp, float ang_damp )

elf.SetActorSleepThresholds( object actor, float lin_thrs, float ang_thrs )

elf.SetActorRestitution( object actor, float restitution )

elf.SetActorAnisotropicFriction( object actor, float x, float y, float z )

elf.SetActorLinearFactor( object actor, float x, float y, float z )

elf.SetActorAngularFactor( object actor, float x, float y, float z )

elf.AddForceToActor( object actor, float x, float y, float z )

elf.AddForceToActorLocal( object actor, float x, float y, float z )

elf.AddTorqueToActor( object actor, float x, float y, float z )

elf.SetActorLinearVelocity( object actor, float x, float y, float z )

elf.SetActorLinearVelocityLocal( object actor, float x, float y, float z )

elf.SetActorAngularVelocity( object actor, float x, float y, float z )

elf_vec3f elf.GetActorBoundingLengths( object actor )

elf_vec3f elf.GetActorBoundingOffset( object actor )

int elf.GetActorShape( object actor )

float elf.GetActorMass( object actor )

float elf.GetActorLinearDamping( object actor )

float elf.GetActorAngularDamping( object actor )

float elf.GetActorLinearSleepThreshold( object actor )

float elf.GetActorAngularSleepThreshold( object actor )

float elf.GetActorRestitution( object actor )

elf_vec3f elf.GetActorAnisotropicFriction( object actor )

elf_vec3f elf.GetActorLinearFactor( object actor )

elf_vec3f elf.GetActorAngularFactor( object actor )

elf_vec3f elf.GetActorLinearVelocity( object actor )

elf_vec3f elf.GetActorAngularVelocity( object actor )

object elf.AddHingeJointToActor( object actor, object actor2, string name, float px, float py, float pz, float ax, float ay, float az )

object elf.AddBallJointToActor( object actor, object actor2, string name, float px, float py, float pz )

object elf.AddConeTwistJointToActor( object actor, object actor2, string name, float px, float py, float pz, float ax, float ay, float az )

object elf.GetActorJointByName( object actor, string name )

object elf.GetActorJointByIndex( object actor, int idx )

bool elf.RemoveActorJointByName( object actor, string name )

bool elf.RemoveActorJointByIndex( object actor, int idx )

bool elf.RemoveActorJointByObject( object actor, object joint )

elf.SetActorIpoFrame( object actor, float frame )

elf.PlayActorIpo( object actor, float start, float end, float speed )

elf.LoopActorIpo( object actor, float start, float end, float speed )

elf.StopActorIpo( object actor )

elf.PauseActorIpo( object actor )

elf.ResumeActorIpo( object actor )

float elf.GetActorIpoStart( object actor )

float elf.GetActorIpoEnd( object actor )

float elf.GetActorIpoSpeed( object actor )

float elf.GetActorIpoFrame( object actor )

bool elf.IsActorIpoPlaying( object actor )

bool elf.IsActorIpoPaused( object actor )

int elf.GetActorCollisionCount( object actor )

object elf.GetActorCollision( object actor, int idx )

int elf.GetActorPropertyCount( object actor )

elf.AddPropertyToActor( object actor, object property )

object elf.GetActorPropertyByName( object actor, string name )

object elf.GetActorPropertyByIndex( object actor, int idx )

bool elf.RemoveActorPropertyByName( object actor, string name )

bool elf.RemoveActorPropertyByIndex( object actor, int idx )

bool elf.RemoveActorPropertyByObject( object actor, object property )

elf.RemoveActorProperties( object actor )

elf.SetActorSelected( object actor, bool selected )

bool elf.GetActorSelected( object actor )

CAMERA FUNCTIONS

object elf.CreateCamera( string name )

elf.SetCameraViewport( object camera, int x, int y, int width, int height )

elf.SetCameraPerspective( object camera, float fov, float aspect, float clip_near, float clip_far )

elf.SetCameraOrthographic( object camera, int x, int y, int width, int height, float clip_near, float clip_far )

elf_vec2i elf.GetCameraViewportSize( object camera )

elf_vec2i elf.GetCameraViewportOffset( object camera )

float elf.GetCameraFov( object camera )

float elf.GetCameraAspect( object camera )

elf_vec2f elf.GetCameraClip( object camera )

elf_vec2f elf.GetCameraFarPlaneSize( object camera )

elf_vec3f elf.UnProjectCameraPoint( object camera, float x, float y, float z )

MESH DATA FUNCTIONS

object elf.CreateVertice( )

elf.SetVerticePosition( object vertice, float x, float y, float z )

elf.SetVerticeNormal( object vertice, float x, float y, float z )

elf.SetVerticeTexCoord( object vertice, float u, float v )

elf_vec3f elf.GetVerticePosition( object vertice )

elf_vec3f elf.GetVerticeNormal( object vertice )

elf_vec2f elf.GetVerticeTexCoord( object vertice )

int elf.GetFaceV1( object face )

int elf.GetFaceV2( object face )

int elf.GetFaceV3( object face )

object elf.CreateMeshData( )

int elf.GetMeshDataVerticeCount( object mesh_data )

int elf.GetMeshDataFaceCount( object mesh_data )

elf.AddVerticeToMeshData( object mesh_data, object vertice )

elf.AddFaceToMeshData( object mesh_data, int v1, int v2, int v3 )

object elf.GetVerticeFromMeshData( object mesh_data, int idx )

object elf.GetFaceFromMeshData( object mesh_data, int idx )

MODEL FUNCTIONS

object elf.CreateModelFromMeshData( object data )

elf.SetModelName( object model, string name )

string elf.GetModelName( object model )

string elf.GetModelFilePath( object model )

int elf.GetModelVerticeCount( object model )

int elf.GetModelIndiceCount( object model )

elf_vec3f elf.GetModelBoundingBoxMin( object model )

elf_vec3f elf.GetModelBoundingBoxMax( object model )

ENTITY FUNCTIONS

object elf.CreateEntity( string name )

elf.GenerateEntityTangents( object entity )

elf.SetEntityScale( object entity, float x, float y, float z )

elf_vec3f elf.GetEntityScale( object entity )

elf.SetEntityModel( object entity, object model )

elf.ClearEntityModel( object entity )

object elf.GetEntityModel( object entity )

int elf.GetEntityMaterialCount( object entity )

elf.AddEntityMaterial( object entity, object material )

elf.SetEntityMaterial( object entity, int idx, object material )

elf.RemoveEntityMaterial( object entity, int idx )

object elf.GetEntityMaterial( object entity, int idx )

elf.SetEntityVisible( object entity, bool visible )

bool elf.GetEntityVisible( object entity )

elf.SetEntityPhysics( object entity, int type, float mass )

elf.DisableEntityPhysics( object entity )

elf.SetEntityArmature( object entity, object armature )

elf.SetEntityArmatureFrame( object entity, float frame )

elf.PlayEntityArmature( object entity, float start, float end, float speed )

elf.LoopEntityArmature( object entity, float start, float end, float speed )

elf.StopEntityArmature( object entity )

elf.PauseEntityArmature( object entity )

elf.ResumeEntityArmature( object entity )

float elf.GetEntityArmatureStart( object entity )

float elf.GetEntityArmatureEnd( object entity )

float elf.GetEntityArmatureSpeed( object entity )

float elf.GetEntityArmatureFrame( object entity )

bool elf.IsEntityArmaturePlaying( object entity )

bool elf.IsEntityArmaturePaused( object entity )

object elf.GetEntityArmature( object entity )

bool elf.GetEntityChanged( object entity )

LIGHT FUNCTIONS

object elf.CreateLight( string name )

int elf.GetLightType( object light )

elf_color elf.GetLightColor( object light )

float elf.GetLightDistance( object light )

float elf.GetLightFadeSpeed( object light )

bool elf.GetLightShadowCaster( object light )

bool elf.GetLightVisible( object light )

elf_vec2f elf.GetLightCone( object light )

bool elf.IsLightShaft( object light )

float elf.GetLightShaftSize( object light )

float elf.GetLightShaftIntensity( object light )

float elf.GetLightShaftFadeOff( object light )

elf.SetLightType( object light, int type )

elf.SetLightColor( object light, float r, float g, float b, float a )

elf.SetLightDistance( object light, float distance )

elf.SetLightFadeSpeed( object light, float fade_speed )

elf.SetLightShadowCaster( object light, bool shadow_caster )

elf.SetLightVisible( object light, bool visible )

elf.SetLightCone( object light, float inner_cone, float outer_cone )

elf.SetLightShaft( object light, float size, float intensity, float fade_off )

elf.DisableLightShaft( object light )

BONE FUNCTIONS

object elf.GetBoneArmature( object bone )

object elf.GetBoneParent( object bone )

object elf.GetBoneChildByName( object bone, string name )

object elf.GetBoneChildById( object bone, int id )

object elf.GetBoneChildByIndex( object bone, int idx )

elf_vec3f elf.GetBonePosition( object bone )

elf_vec3f elf.GetBoneRotation( object bone )

elf_vec4f elf.GetBoneOrientation( object bone )

ARMATURE FUNCTIONS

object elf.CreateArmature( string name )

object elf.GetBoneFromArmatureByName( string name, object armature )

object elf.GetBoneFromArmatureById( int id, object armature )

PARTICLES FUNCTIONS

object elf.CreateParticles( string name, int max_count )

string elf.GetParticlesName( object particles )

string elf.GetParticlesFilePath( object particles )

elf.SetParticlesMaxCount( object particles, int max_count )

elf.SetParticlesDrawMode( object particles, int mode )

elf.SetParticlesTexture( object particles, object texture )

elf.ClearParticlesTexture( object particles )

elf.SetParticlesModel( object particles, object model )

elf.ClearParticlesModel( object particles )

elf.SetParticlesEntity( object particles, object entity )

elf.ClearParticlesEntity( object particles )

elf.SetParticlesGravity( object particles, float x, float y, float z )

elf.SetParticlesSpawnDelay( object particles, float delay )

elf.SetParticlesSpawn( object particles, bool spawn )

elf.SetParticlesSize( object particles, float min, float max )

elf.SetParticlesSizeGrowth( object particles, float min, float max )

elf.SetParticlesRotation( object particles, float min, float max )

elf.SetParticlesRotationGrowth( object particles, float min, float max )

elf.SetParticlesLifeSpan( object particles, float min, float max )

elf.SetParticlesFadeSpeed( object particles, float min, float max )

elf.SetParticlesPositionMin( object particles, float x, float y, float z )

elf.SetParticlesPositionMax( object particles, float x, float y, float z )

elf.SetParticlesVelocityMin( object particles, float x, float y, float z )

elf.SetParticlesVelocityMax( object particles, float x, float y, float z )

elf.SetParticlesColorMin( object particles, float r, float g, float b, float a )

elf.SetParticlesColorMax( object particles, float r, float g, float b, float a )

int elf.GetParticlesMaxCount( object particles )

int elf.GetParticlesCount( object particles )

int elf.GetParticlesDrawMode( object particles )

object elf.GetParticlesTexture( object particles )

object elf.GetParticlesModel( object particles )

object elf.GetParticlesEntity( object particles )

elf_vec3f elf.GetParticlesGravity( object particles )

float elf.GetParticlesSpawnDelay( object particles )

bool elf.GetParticlesSpawn( object particles )

float elf.GetParticlesSizeMin( object particles )

float elf.GetParticlesSizeMax( object particles )

float elf.GetParticlesSizeGrowthMin( object particles )

float elf.GetParticlesSizeGrowthMax( object particles )

float elf.GetParticlesRotationMin( object particles )

float elf.GetParticlesRotationMax( object particles )

float elf.GetParticlesRotationGrowthMin( object particles )

float elf.GetParticlesRotationGrowthMax( object particles )

float elf.GetParticlesLifeSpanMin( object particles )

float elf.GetParticlesLifeSpanMax( object particles )

float elf.GetParticlesFadeSpeedMin( object particles )

float elf.GetParticlesFadeSpeedMax( object particles )

elf_vec3f elf.GetParticlesPositionMin( object particles )

elf_vec3f elf.GetParticlesPositionMax( object particles )

elf_vec3f elf.GetParticlesVelocityMin( object particles )

elf_vec3f elf.GetParticlesVelocityMax( object particles )

elf_color elf.GetParticlesColorMin( object particles )

elf_color elf.GetParticlesColorMax( object particles )

object elf.CreateSprite( string name )

elf.SetSpriteMaterial( object sprite, object material )

elf.SetSpriteScale( object sprite, float x, float y )

elf.SetSpriteFaceCamera( object sprite, bool face_camera )

object elf.GetSpriteMaterial( object sprite )

elf_vec2f elf.GetSpriteScale( object sprite )

bool elf.GetSpriteFaceCamera( object sprite )

object elf.CreateScene( string name )

SCENE FUNCTIONS

object elf.CreateSceneFromFile( string file_path )

bool elf.SaveScene( object scene, string file_path )

elf.SetSceneAmbientColor( object scene, float r, float g, float b, float a )

elf_color elf.GetSceneAmbientColor( object scene )

elf.SetSceneGravity( object scene, float x, float y, float z )

elf_vec3f elf.GetSceneGravity( object scene )

elf.SetScenePhysics( object scene, bool physics )

bool elf.GetScenePhysics( object scene )

elf.SetSceneRunScripts( object scene, bool run_scripts )

bool elf.GetSceneRunScripts( object scene, bool run_scripts )

string elf.GetSceneName( object scene )

string elf.GetSceneFilePath( object scene )

int elf.GetSceneCameraCount( object scene )

int elf.GetSceneEntityCount( object scene )

int elf.GetSceneLightCount( object scene )

int elf.GetSceneArmatureCount( object scene )

int elf.GetSceneParticlesCount( object scene )

int elf.GetSceneSpriteCount( object scene )

elf.AddCameraToScene( object scene, object camera )

elf.AddEntityToScene( object scene, object entity )

elf.AddLightToScene( object scene, object light )

elf.AddParticlesToScene( object scene, object particles )

elf.AddSpriteToScene( object scene, object sprite )

elf.SetSceneActiveCamera( object scene, object camera )

object elf.GetSceneActiveCamera( object scene )

object elf.GetSceneRayCastResult( object scene, float x, float y, float z, float dx, float dy, float dz )

object elf.GetSceneRayCastResults( object scene, float x, float y, float z, float dx, float dy, float dz )

object elf.GetDebugSceneRayCastResult( object scene, float x, float y, float z, float dx, float dy, float dz )

object elf.GetDebugSceneRayCastResults( object scene, float x, float y, float z, float dx, float dy, float dz )

object elf.GetCameraByIndex( object scene, int idx )

object elf.GetEntityByIndex( object scene, int idx )

object elf.GetLightByIndex( object scene, int idx )

object elf.GetArmatureByIndex( object scene, int idx )

object elf.GetParticlesByIndex( object scene, int idx )

object elf.GetSpriteByIndex( object scene, int idx )

object elf.GetTextureByName( object scene, string name )

object elf.GetMaterialByName( object scene, string name )

object elf.GetModelByName( object scene, string name )

object elf.GetScriptByName( object scene, string name )

object elf.GetCameraByName( object scene, string name )

object elf.GetEntityByName( object scene, string name )

object elf.GetLightByName( object scene, string name )

object elf.GetArmatureByName( object scene, string name )

object elf.GetParticlesByName( object scene, string name )

object elf.GetSpriteByName( object scene, string name )

object elf.GetActorByName( object scene, string name )

bool elf.RemoveCameraByName( object scene, string name )

bool elf.RemoveEntityByName( object scene, string name )

bool elf.RemoveLightByName( object scene, string name )

bool elf.RemoveParticlesByName( object scene, string name )

bool elf.RemoveSpriteByName( object scene, string name )

bool elf.RemoveCameraByIndex( object scene, int idx )

bool elf.RemoveEntityByIndex( object scene, int idx )

bool elf.RemoveLightByIndex( object scene, int idx )

bool elf.RemoveParticlesByIndex( object scene, int idx )

bool elf.RemoveSpriteByIndex( object scene, int idx )

bool elf.RemoveCameraByObject( object scene, object camera )

bool elf.RemoveEntityByObject( object scene, object entity )

bool elf.RemoveLightByObject( object scene, object light )

bool elf.RemoveParticlesByObject( object scene, object particles )

bool elf.RemoveSpriteByObject( object scene, object sprite )

bool elf.RemoveActorByObject( object scene, object actor )

object elf.GetSceneScripts( object scene )

object elf.GetSceneTextures( object scene )

object elf.GetSceneMaterials( object scene )

object elf.GetSceneModels( object scene )

SCRIPT FUNCTIONS

object elf.CreateScript( string name )

object elf.CreateScriptFromFile( string file_path )

elf.SetScriptName( object script, string name )

string elf.GetScriptName( object script )

string elf.GetScriptFilePath( object script )

elf.SetScriptText( object script, string text )

bool elf.IsScriptError( object script )

bool elf.RunString( string str )

bool elf.RunScript( object script )

AUDIO FUNCTIONS

elf.SetAudioVolume( float volume )

float elf.GetAudioVolume( )

elf.SetAudioRolloff( float rolloff )

float elf.GetAudioRolloff( )

object elf.LoadSound( string file_path )

object elf.LoadStreamedSound( string file_path )

int elf.GetSoundFileType( object sound )

object elf.PlaySound( object sound, float volume )

object elf.PlayEntitySound( object entity, object sound, float volume )

object elf.LoopSound( object sound, float volume )

object elf.LoopEntitySound( object entity, object sound, float volume )

elf.SetSoundVolume( object source, float volume )

float elf.GetSoundVolume( object source )

elf.PauseSound( object source )

elf.ResumeSound( object source )

elf.StopSound( object source )

bool elf.IsSoundPlaying( object source )

bool elf.IsSoundPaused( object source )

COLLISION FUNCTIONS

object elf.GetCollisionActor( object collision )

elf_vec3f elf.GetCollisionPosition( object collision )

elf_vec3f elf.GetCollisionNormal( object collision )

float elf.GetCollisionDepth( object collision )

JOINT FUNCTIONS

string elf.GetJointName( object joint )

int elf.GetJointType( object joint )

object elf.GetJointActorA( object joint )

object elf.GetJointActorB( object joint )

elf_vec3f elf.GetJointPivot( object joint )

elf_vec3f elf.GetJointAxis( object joint )

FONT FUNCTIONS

object elf.CreateFontFromFile( string file_path, int size )

string elf.GetFontName( object font )

string elf.GetFontFilePath( object font )

int elf.GetFontSize( object font )

int elf.GetStringWidth( object font, string str )

int elf.GetStringHeight( object font, string str )

GUI OBJECT FUNCTIONS

Gui object functions can be performed on all gui object types [Labels|Buttons|Pictures|etc...]

string elf.GetGuiObjectName( object object )

elf_vec2i elf.GetGuiObjectPosition( object object )

elf_vec2i elf.GetGuiObjectSize( object object )

elf_color elf.GetGuiObjectColor( object object )

bool elf.GetGuiObjectVisible( object object )

object elf.GetGuiObjectScript( object object )

int elf.GetGuiObjectEvent( object object )

elf.SetGuiObjectPosition( object object, float x, float y )

elf.SetGuiObjectColor( object object, float r, float g, float b, float a )

elf.SetGuiObjectVisible( object object, bool visible )

elf.SetGuiObjectScript( object object, object script )

LABEL FUNCTIONS

object elf.CreateLabel( string name )

object elf.GetLabelFont( object label )

string elf.GetLabelText( object label )

elf.SetLabelFont( object label, object font )

elf.SetLabelText( object label, string text )

BUTTON FUNCTIONS

object elf.CreateButton( string name )

bool elf.GetButtonState( object button )

object elf.GetButtonOffTexture( object button )

object elf.GetButtonOverTexture( object button )

object elf.GetButtonOnTexture( object button )

elf.SetButtonOffTexture( object button, object off )

elf.SetButtonOverTexture( object button, object over )

elf.SetButtonOnTexture( object button, object on )

PICTURE FUNCTIONS

object elf.CreatePicture( string name )

object elf.GetPictureTexture( object picture )

elf_vec2f elf.GetPictureScale( object picture )

elf.SetPictureTexture( object picture, object texture )

elf.SetPictureScale( object picture, float x, float y )

TEXT FIELD FUNCTIONS

object elf.CreateTextField( string name )

object elf.GetTextFieldTexture( object text_field )

object elf.GetTextFieldFont( object text_field )

elf_color elf.GetTextFieldTextColor( object text_field )

elf_vec2i elf.GetTextFieldOffset( object text_field )

string elf.GetTextFieldText( object text_field )

elf.SetTextFieldTexture( object text_field, object texture )

elf.SetTextFieldFont( object text_field, object font )

elf.SetTextFieldTextColor( object text_field, float r, float g, float b, float a )

elf.SetTextFieldOffset( object text_field, int offset_x, int offset_y )

elf.SetTextFieldCursorPosition( object text_field, int idx )

elf.SetTextFieldText( object text_field, string text )

SLIDER FUNCTIONS

object elf.CreateSlider( string name )

object elf.GetSliderBackgroundTexture( object slider )

object elf.GetSliderSliderTexture( object slider )

float elf.GetSliderValue( object slider )

elf.SetSliderBackgroundTexture( object slider, object background )

elf.SetSliderSliderTexture( object slider, object slider_texture )

elf.SetSliderValue( object slider, float value )

SCREEN FUNCTIONS

object elf.CreateScreen( string name )

object elf.GetScreenTexture( object screen )

elf.SetScreenTexture( object screen, object texture )

elf.SetScreenToTop( object screen )

elf.ForceFocusToScreen( object screen )

elf.ReleaseFocusFromScreen( object screen )

TEXT LIST FUNCTIONS

object elf.CreateTextList( string name )

object elf.GetTextListFont( object text_list )

elf_color elf.GetTextListSelectionColor( object text_list )

elf_color elf.GetTextListLightColor( object text_list )

elf_color elf.GetTextListDarkColor( object text_list )

int elf.GetTextListRowCount( object text_list )

int elf.GetTextListItemCount( object text_list )

int elf.GetTextListSelectionIndex( object text_list )

int elf.GetTextListOffset( object text_list )

string elf.GetTextListItem( object text_list, int idx )

string elf.GetTextListSelectedItem( object text_list )

elf.SetTextListFont( object text_list, object font )

elf.SetTextListSelectionColor( object text_list, float r, float g, float b, float a )

elf.SetTextListLightColor( object text_list, float r, float g, float b, float a )

elf.SetTextListDarkColor( object text_list, float r, float g, float b, float a )

elf.SetTextListSize( object text_list, int rows, int width )

elf.AddTextListItem( object text_list, string text )

elf.SetTextListItem( object text_list, int idx, string text )

bool elf.RemoveTextListItem( object text_list, int idx )

elf.RemoveTextListItems( object text_list )

elf.SetTextListOffset( object text_list, int offset )

elf.SetTextListSelection( object text_list, int selection )

CHECK BOX FUNCTIONS

object elf.CreateCheckBox( string name )

bool elf.GetCheckBoxState( object check_box )

object elf.GetCheckBoxOffTexture( object check_box )

object elf.GetCheckBoxOnTexture( object check_box )

elf.SetCheckBoxOffTexture( object check_box, object off )

elf.SetCheckBoxOnTexture( object check_box, object on )

elf.SetCheckBoxState( object check_box, bool state )

GUI FUNCTIONS

object elf.CreateGui( )

bool elf.AddGuiObject( object parent, object object )

object elf.GetGuiObjectByName( object parent, string name )

object elf.GetGuiObjectByIndex( object parent, int idx )

bool elf.RemoveGuiObjectByName( object parent, string name )

bool elf.RemoveGuiObjectByIndex( object parent, int idx )

bool elf.RemoveGuiObjectByObject( object parent, object object )

object elf.GetGuiTrace( object gui )

object elf.GetGuiFocus( object gui )

object elf.GetGuiActiveTextField( object gui )

elf.EmptyGui( object gui )

NETWORKING FUNCTIONS

bool elf.CreateSession( string address, unsigned short port )

bool elf.ConnectSession( string address, unsigned short port )

bool elf.DisconnectSession( )

elf.SendStringToClients( string message )

elf.SendStringToServer( string message )

string elf.GetServerDataAsString( )

string elf.GetClientDataAsString( )

int elf.GetServerEvent( )

int elf.GetClientEvent( )

int elf.GetCurrentClient( )

bool elf.IsServer( )

bool elf.IsClient( )