Package Max

schedule

Schedule messages on high priority scheduler thread

Description

The schedule object schedules messages to execute on the high priority scheduler thread, optionally with a delay time (ms), and optionally deferring to main application thread after the delay time. Similar to the delay and pipe objects, but supports arbitrary messages.

Arguments

delay[number]
optional

Sets the delay time in milliseconds. Default is zero.

Attributes

defer[int]

When enabled, any scheduled message will be deferred to main application thread before being sent out the schedule object's outlet.

delay[float]

The amount of delay time in milliseconds used to schedule any incoming messages into the future.

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background[int]: 0

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color[4 floats]

Sets the color for the object box outline.

fontface[int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname[symbol]

Sets the object's font.

fontsize[float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden[int]: 0

Toggles whether an object is hidden when the patcher is locked.

hint[symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick[int]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

Sets the position and size of the object in the patcher window.

position[2 floats]
write-only

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation[int]: 0

Sets whether an object belongs to the patcher's presentation.

presentation_rect[4 floats]: 0. 0. 0. 0.

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect[4 floats]
write-only

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size[2 floats]
write-only

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor[4 floats]

Sets the color for the object's text in RGBA format.

textjustification[int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

valuepopup[int]: 0

For objects with single values, enabling valuepopup will display the object's current value in a popup caption when the mouse is over the object or it is being changed with the mouse.

valuepopuplabel[int]: 0

Sets the source of a text label shown in a value popup caption. Possible values:

0 = 'None'
1 = 'Hint'
2 = 'Scripting Name'
3 = 'Parameter Long Name'
4 = 'Parameter Short Name'

varname[symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

Same as anything .

int

Same as anything .

Arguments:
  • input [int]

float

Same as anything .

Arguments:
  • input [float]

list

Same as anything .

Arguments:
  • input [list]

anything

Schedules the messages to execute on the high priority scheduler thread. If a non-zero delay time is set, the message will be scheduled that number of milliseconds into the future. If defer is enabled, the message will then be deferred to main application thread before being sent out the schedule object's outlet.

Arguments:
  • input [list]

clear

If there have been any messages scheduled that have not been output, the clear message will remove them from the scheduler and prevent them from being output.

sendmessage

Same as anything , but strips the "sendmessage" first element of the output message. This is useful if you need to schedule a message that uses any of the schedule object's message or attribute names like clear, delay, or defer.

Arguments:
  • input [list]

See Also

Name Description
defer Defer execution of a message
delay Delay a bang
pipe Delay numbers, lists or symbols
threadcheck Report the thread of execution for a message