- press ENTER to search or ESC to cancel
Table of content
Globals namespaces
Constants
- Align
- AniDir
- BlendMode
- BrushPattern
- BrushType
- ColorMode
- FilterChannels
- Ink
- MouseButton
- MouseCursor
- RangeType
- SelectionMode
- SpriteSheetDataFormat
- SpriteSheetType
- WebSocketMessageType
Classes/objects
- Brush
- Cel
- Color
- ColorSpace
- Dialog
- Editor
- Events
- Frame
- GraphicsContext
- Image
- ImageSpec
- KeyEvent
- Layer
- MouseEvent
- Palette
- Plugin
- Point
- Properties
- Range
- Rectangle
- Selection
- Site
- Size
- Slice
- Sprite
- Tag
- Tile
- Tileset
- Timer
- Tool
- TouchEvent
- Version
- WebSocket
- Window
Cel
A cel is an image in a specific xy-coordinate, and a specific layer/frame combination.
Cel.sprite
local sprite = cel.sprite
Cels belong to one sprite. This property returns that sprite.
Cel.layer
local layer = cel.layer
Returns the layer where this cel is located.
Cel.frame
local frame = cel.frame
cel.frame = newFrame
Returns the frame object which this cel belongs. If you set this property, the cel will be moved to the given frame (if another cel already exists in that frame, it will be removed).
Cel.frameNumber
local frameNumber = cel.frameNumber
cel.frameNumber = newFrameNumber
Returns the frame number which this cel belongs, the frame number 1
is the first frame (not 0). If you set this property the cel will be
moved to the given frameNumber, check the notes of Cel.frame.
Cel.image
local image = cel.image
cel.image = newImage
Gets or sets the image with the pixels of this cel. This is the preferred way to replace the cel image, because it generates only one undoable action.
Cel.bounds
local bounds = cel.bounds
Returns the rectangle with the cel bounds (position and size).
Cel.position
local position = cel.position
cel.position = newPosition
Gets or sets the cel position.
Cel.opacity
local opacity = cel.opacity
cel.opacity = newOpacity
Gets or sets the cel opacity. A value from 0 to 255 (which means
0=0% completely transparent, or 255=100% completely opaque).
Cel.zIndex
local zIndex = cel.zIndex
cel.zIndex = newZIndex
Gets or sets the cel z-index value. By default 0, which means "show
this cel in the same position as its layer", but can be modified to
positive values to move the cel to the front, or negative values to
move it to the back.
It offers a way to change the order of layers in one specific frame.
Note: The value is limited to the [-32768,32767] range.
Cel.color
local color = cel.color
cel.color = newColor
Gets or sets the user-defined color of this cel in the timeline.
Cel.data
local data = cel.data
cel.data = newData
Gets or sets the user-defined data related to this cel (a text string).
Cel.properties
Access user-defined and extension-defined properties of this cel.