Contents


Edit this page

layer

< API

layer’s correspondent type in the Stippe Effect source code is LayerRep.

Note: LayerRep stores an immutable reference to the project that contains the layer, and to its layer index. This means that a layer reference in script can be “spoiled” - i.e. cease to refer to the same layer or no longer refer to a valid layer at all - if the number of layers in the project are changed, or if the order of the layers in the project is changed.

Properties

These definitions use the arbitrary layer object L as the caller.

index

L.index -> int

Returns the layer index of L. The lowest layer in a project has an index of 0.

project

L.project -> project

Returns the project to which L belongs.

Functions

For an arbitrary layer object named L, functions of the form L.func_name(parameters) -> return_type are value-returning functions, while functions of the form L.func_name(parameters); are void functions, which perform an action but return nothing.

is_linked

L.is_linked() -> bool

Returns true if the cels in layer L are linked, false otherwise.

link_cels

L.link_cels();

Links the cels of the layer L together. This means that all of the cels in L will display the same image, and that changes made on any cel of layer L will be propagated to all of the cels of L. The linked content will be set from the cel at the current frame index.

unlink_cels

L.unlink_cels();

Unlinks the cels of the layer L. If L was previously linked, all its cel will still initially appear to be the same, but can now be modified independently.

is_enabled

L.is_enabled() -> bool

Returns true if the layer L is enabled i.e. visible, false otherwise.

disable

L.disable();

Disables the layer L, i.e. makes it invisible.

enable

L.enable();

Enables the layer L, i.e. makes it visible.

is_opaque

L.is_opaque() -> bool

Returns true if the layer L has an opacity of 1.0 (represented as 255 in Stipple Effect), false otherwise.

get_opacity

L.get_opacity() -> float

Returns the opacity of layer L as a float ranging from 0.0 (transparent) to 1.0 (opaque).

set_opacity

L.set_opacity(float opacity);

Sets the opacity of the layer L to opacity.

Fails:

Any of the following will cause the function not to execute:

  • opacity < 0.0
  • opacity > 1.0

get_name

L.get_name() -> string

Returns the name of the layer L.

set_name

L.set_name(string name);

Sets the name of the layer L to name.

Fails:

Any of the following will cause the function not to execute:

  • If name is ""
  • If name contains any of the following characters: 
      { '/', '\\', ':', '*', '?', '"', '<', '>', '|', '{', '}' }

get_cel

L.get_cel(int i) -> image

Returns the cel contents of layer L at frame index i. If the cels of layer L are linked, the function will return the linked content.

Throws:

Any of the following will result in a runtime error:

  • i < 0
  • i >= L.project.get_frame_count()

set_cel

L.set_cel(int i, image content);

Sets the content to the cel at index i of the layer L to the image content.

Fails:

Any of the following will cause the function not to execute:

  • content.w != L.project.get_width()
  • content.h != L.project.get_height()
  • i < 0
  • i >= L.project.get_frame_count()

edit_cel

L.edit_cel(int i, image drawn);

Draws the image drawn on top of the cel’s existing contents at position (0, 0).

Fails:

Any of the following will cause the function not to execute:

  • i < 0
  • i >= L.project.get_frame_count()

wipe_cel

L.wipe_cel(int i);

Erases the contents of the cel at index i of the layer L. Resultingly, cel i of L will consist of a fully transparent image.

Fails:

Any of the following will cause the function not to execute:

  • i < 0
  • i >= L.project.get_frame_count()