object:rotate()

Type Function

Object DisplayObject

Library display.*

Return value none

Revision Release 2024.3703

Keywords rotate, rotation

See also object.rotation

Overview

Effectively adds a value (deltaAngle) to the object's current rotation. This rotation is based on degrees in the clockwise direction. The rotation occurs around the object's anchor point.

Use object.rotation to set (or get) the current rotation value of the object.

Gotchas

This cannot be used on a physical body during a collision event. However, your collision handler may set a flag or include a time delay via timer.performWithDelay() so that the action can occur in the next application cycle or later. See the Collision Detection guide for a complete list of which APIs and methods are subject to this rule.

Syntax

object:rotate( deltaAngle )

deltaAngle _^(required)

Number. Degrees to rotate. A positive number rotates the object clockwise and a negative number rotates the object counter-clockwise.

Example

local rect = display.newRect( 50, 50, 100, 200 )
rect:setFillColor( 1, 0, 0 )

-- Rotate the rectangle 45 degrees
rect:rotate( 45 )