/===================================== class OverlayAnimatedSprite : Overlay //===================================== >> An generic overlay that displays any > given images. -------------- Type: Refrence -------------- ------------- Group: Client ------------- ------------- Constructors: ------------- OverlayAnimatedSprite(); Arguments: N/A -------- Methods: -------- void addOverlay( Overlay@ overlay ); Function: Add a graphical overlay Arguments: Overlay@ - Object Handle to the Overlay to be added Returns: N/A bool removeOverlay( Overlay@ overlay ); Function: Remove a graphical overlay Arguments: Overlay@ - Object Handle to the Overlay to be removed Returns: bool - true: The overlay was found and removed false: The overlay was not found void setIdleImage( string path ); Function: Set the image that will be displayed while not animating Arguments: string - The file path to the image Returns: N/A void addNextImage( string path, float delay ); Function: Add an image to the animation sequence, they should be added in the order you wish them to display Arguments: string - The file path to the image delay - how long to display this frame before moving to the next Returns: N/A bool loop() const; Function: Query if the animation is looping Arguments: N/A Returns: bool - true: The animation is looping false: The animation is not looping void loop( bool ); Function: Set wheather the animation should loop or not Arguments: bool - true: The animation should loop false: The animation should not loop Returns: N/A bool isIdle() const; Function: Query if the animation is idle (not animating) Arguments: N/A Returns: bool - true: The animation is idle false: The animation is animating void startAnimation(); Function: Start the animation animating from the first frame, no mater what state it is in Arguments: N/A Returns: N/A void rotation( float ); Function: Set the rotation of this overlay Arguments: float - the overlays new rotation Returns: N/A float x() const; Function: Get the x coordinate of the position in the world Arguments: N/A Returns: float - the x coordinate float y() const; Function: Get the y coordinate of the position in the world Arguments: N/A Returns: float - the y coordinate void position( float x, float y ); Function: Set the x and y coordinates for this overlay Arguments: float - the new y coordinate float - the new x coordinate Returns: N/A void position( const Vector2d ); Function: Set the position coordinates Arguments: Vector2d - the new position Returns: N/A Vector2d position(); Function: Get the position coordinates Arguments: N/A Returns: Vector2d - the object's position float rotation() const; Function: Get the rotation of this overlay Arguments: N/A Returns: float - the overlays rotation void rotation( float ); Function: Set the rotation of this overlay Arguments: float - the overlays new rotation Returns: N/A