-
Notifications
You must be signed in to change notification settings - Fork 3
Actor API
An internal function to set internal variables for the actor to some default values!
Switchs the current animation for the actor. Stops the previous animation and starts the new animation defined by newState! See also onSwitch
Renders the Actor or more precisely just the current state/animation for the actor! The varargs are basically love.draw parameters starting from x!
Checks if the current animation of the actor is active or not
Stops the current animation!
Starts the current animation for the actor!
Adds a new animation animName for the actor defined by param which could either be a image name (an XML must exist in the same path by the name for that to work), or an Animation or a table defining a new animation exactly similar to the one expected in animx.newAnimation!
Exports the actor (all the animations associated with it) to a single XML file! It must be noted that this may result in buggy behaviour if animations are from different sources so use this only when all the animations belong to the same source/atlas!
For the interface animx.hideWarnings defines whether or not to show warning if something went wrong (like a filename by the same name already exists, etc)!
Defines the handler that should be executed whenever an animation is changed/switched! The handler takes in the actor and the previousState as parameters!
Returns the given or current animation if given arg is nil
Returns the current animation that's being rendered. It does the exact same job as Actor:getAnimation() with no arguments!!
Gets a table of all the states (animations basically). The order is undefined!
Loops all the animations in the actor. See also animation modes! So you don't have to go through all animations and loop each one individually!
Returns the name of the current state/animation!
Returns the dimensions of the quad for the current animation! Also see Animation:getDimensions()
Returns the width of the quad for the current animation! Also see Animation:getWidth()
Returns the height of the quad for the current animation! Also see Animation:getHeight()
Sets the style of the image for the current animation! Also see Animation:setStyle()
Flips the current animation along given axes (boolean values). Also see Animation:flip()
Flips the current animation along x-axis if b is some truthy value. Also see Animation:flipX()
Flips the current animation along y-axis if b is some truthy value. Also see Animation:flipY()
There are numerous aliases for the above functions which you can use:-
Actor.getCurrentAnim=Actor.getCurrentAnimation
Actor.getState=Actor.getName
Actor.changeAnim=Actor.switch
Actor.set=Actor.switch
Actor.draw=Actor.render