GreasePencilFrames(bpy_struct)

base class — bpy_struct

class bpy.types.GreasePencilFrames(bpy_struct)

Collection of Grease Pencil frames

new(frame_number)

Add a new Grease Pencil frame

Parameters:

frame_number (int in [-1048574, 1048574]) – Frame Number, The frame on which the drawing appears

Returns:

The newly created frame

Return type:

GreasePencilFrame

remove(frame_number)

Remove a Grease Pencil frame

Parameters:

frame_number (int in [-1048574, 1048574]) – Frame Number, The frame number of the frame to remove

copy(from_frame_number, to_frame_number, *, instance_drawing=False)

Copy a Grease Pencil frame

Parameters:

  • from_frame_number (int in [-1048574, 1048574]) – Source Frame Number, The frame number of the source frame

  • to_frame_number (int in [-1048574, 1048574]) – Frame Number of Copy, The frame number to copy the frame to

  • instance_drawing (boolean, (optional)) – Instance Drawing, Let the copied frame use the same drawing as the source

Returns:

The newly copied frame

Return type:

GreasePencilFrame

move(from_frame_number, to_frame_number)

Move a Grease Pencil frame

Parameters:

  • from_frame_number (int in [-1048574, 1048574]) – Source Frame Number, The frame number of the source frame

  • to_frame_number (int in [-1048574, 1048574]) – Target Frame Number, The frame number to move the frame to

Returns:

The moved frame

Return type:

GreasePencilFrame

classmethod bl_rna_get_subclass(id, default=None)
Parameters:

id (str) – The RNA type identifier.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None)
Parameters:

id (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References