Skip to content

Frame#

This refers to an attribute object that is used to define frames (textures) for drafts.

Presence of the bmp, steal or the lack of said attributes define what attributes are used for what purpose.

Attributes#

bmp#

Type: string

The relative path to the texture file of your draft.

copies#

Type: integer

count#

Type: integer

h#

Type: integer

n#

Type: integer

place x#

Type: integer

X coordinate to place the frame in the texture space.

Only available for privileged drafts.

place y#

Type: integer

Y coordinate to place the frame in the texture space.

Only available for privileged drafts.

skip height factor#

Type: integer

skip width factor#

Type: integer

target h#

Type: integer

Scales the frame to the specified height.

target w#

Type: integer

Scales the frame to the specified width.

w#

Type: integer

x#

Type: integer

y#

Type: integer

Examples#

Empty frame#

An empty frame can be added by passing null in place of an object like so:

{
    "frames": [null]
}