Skyline Lua API  Version 1.0 RC1
Lua Script Reference for Skyline Game Engine.
LUA_API_Anim.h
Go to the documentation of this file.
1 // | _ ____ __ _
2 // | / \ _ _ _ __ __ _/ ___| ___ / _| |_
3 // | / _ \| | | | '__/ _` \___ \ / _ \| |_| __|
4 // | / ___ \ |_| | | | (_| |___) | (_) | _| |_
5 // | /_/ \_\__,_|_| \__,_|____/ \___/|_| \__|
6 // |
7 // | Aurasoft UK 2008 - 2016 http://www.aurasoft.co.uk
8 // |
9 // | Skyline Game Engine Lua API Documentation
10 // |
11 // | This file belongs to Aurasoft UK for the Skyline Game Engine of all versions.
12 // | This file is not for use in any other software that is not owned by Aurasoft UK and cannot be used by any other
13 // | person outside of the Skyline Game Engine development team.
14 // |
15 // | Copyright - Aurasoft UK & Skyline Game Engine 2008 - 2016
16 // |
17 
18 // SKYLINE LUA CLASS FOR API DOCUMENTATION
19 
44 class anim
45 {
46 public:
47 
69  void loadAnimation (int objID, string animationName, int looped, int enabled);
70 
96  void playAnimation (int objID, string animationName, int blendBias, int useBlend);
97 
114  void stopAnimation (int objID, string animationName);
115 
134  void setEnabled (int objID, string animationName, int enabled);
135 
152  void setLooped (int objID, string animationName, int looped);
153 
171  void setLength (int objID, string animationName, float length);
172 
190  void setTime (int objID, string animationName, float timePosition);
191 
221  void setWeight (int objID, string animationName, float blendWeight);
222 
239  void setSpeed (int objID, string animationName, float speedMultiplier);
240 
257  int getEnabled (int objID, string animationName);
258 
275  int getLooped (int objID, string animationName);
276 
293  float getLength (int objID, string animationName);
294 
311  float getTime (int objID, string animationName);
312 
329  float getWeight (int objID, string animationName);
330 
347  float getSpeed (int objID, string animationName);
348 
362  getCurrentAnims( entityID );
363 
364 
379  float getDuration(objID);
380 
394  setDuration(objID, "animName", lengthInSeconds);
395 
409  float getBlendMaskEntry(objID, "animName", boneHandle);
410 
423  setBlendMaskEntry(objID, "animName", boneHandle, weight);
424 
440  string getFromMap(objID,mapName);
441 
442 
443 
444 
445 
446 
447 
448 
449 
450 
451 
452 
453 
454 };
455 
456 
457 
458 
459 
460 
461 
462 
463 
464 
465 
466 
467 
468 
469 
Definition: LUA_API_Anim.h:44
void setSpeed(int objID, string animationName, float speedMultiplier)
Set the speed an animation plays back at.
getCurrentAnims(entityID)
Get the animation table of an entity.
float getDuration(objID)
Get duration.
void setEnabled(int objID, string animationName, int enabled)
Set whether an animation is enabled or not. If you don't an animation to play over the other...
void stopAnimation(int objID, string animationName)
Stop a specific SceneEntity Animation by passing 2 arguments. The Time position and Weight of an anim...
float getBlendMaskEntry(objID,"animName", boneHandle)
Get the blend mask entry.
int getEnabled(int objID, string animationName)
Get the value of an animations enabled state.
float getWeight(int objID, string animationName)
Get the Weight of an animation. Returns as a Float.
void setTime(int objID, string animationName, float timePosition)
Set the time position of an animation, this will let you control the starting point of an animation b...
void setLength(int objID, string animationName, float length)
Set the length an animation shall run. The frames are not resampled, so reducing lower than the anima...
setDuration(objID,"animName", lengthInSeconds)
Set duration.
setBlendMaskEntry(objID,"animName", boneHandle, weight)
Set the blend mask entry.
string getFromMap(objID, mapName)
Get animation from the animation map.
void setWeight(int objID, string animationName, float blendWeight)
Set the weight of an animation to control the blend. A value of 1 means this animation is fully used...
float getSpeed(int objID, string animationName)
Get the Speed multiplier of an animation. Returns as a Float.
int getLooped(int objID, string animationName)
Get the value of an animations looped state.
void loadAnimation(int objID, string animationName, int looped, int enabled)
This Function allows you to load an animation from a sceneEntity into the engine fr callback later...
float getLength(int objID, string animationName)
Get the length of an animation. Returns as a Float.
void playAnimation(int objID, string animationName, int blendBias, int useBlend)
Using this function will allow you to switch animations on a specific sceneEntity. If you pass through the arguments for blending, then your animation will smoothly transit from one animation to another.
void setLooped(int objID, string animationName, int looped)
Set whether an animation is looped or not.
float getTime(int objID, string animationName)
Get the Time position of an animation. Returns as a Float.