<viz:cluster>.setMask

Vizard 7 » Command Index » Vizard modules » viz » <viz:cluster>.setMask

7.6

<viz:cluster>.setMask

Set mask for sending commands to cluster clients

<viz:cluster>.setMask(
mask
)

mask

This can be a combination of the following values:

Cluster masks
viz.ALLCLIENTS	All clients and the master will receive commands.
viz.MASTER	The master will receive commands.
viz.CLIENTX	The specified client will receive commands. Replace X with the client number (ie viz.CLIENT1,viz.CLIENT2,..,viz.CLIENT9).

Remarks

The cluster mask controls which commands get sent to which clients when clustering a script. The mask can be any combination of client IDs. The change made by this command is permanent until you change it back.

Note: The ID of a client is based on the order in which it appears in the cluster master application. You can reorder clients by dragging and dropping the name in the list.

Return Value

The previous cluster mask

Example

#Send the following commands to client 1 and client 3 only
viz.cluster.setMask(viz.CLIENT1|viz.CLIENT3)

#Some commands

#Perform the following commands only on master
viz.cluster.setMask(viz.MASTER)

#Some commands

#Have all clients and the master perform commands
viz.cluster.setMask(viz.ALLCLIENTS)