zone.face.isgroup

Syntax

b := zone.face.isgroup(z,iside,s<,slot>)

Check if the group name s is associated with the zone face indicated by z and iside.

By default, will check if there is a match in any slot. If the slot argument is specified, it will return a match only in that slot.

Note that this function will return a match if any zone attached to the face contains that group name, as well as the face itself. Use of the group logic is described in Groups.

A group pointer and a slot index may be provided instead of a string. This is more efficient, which may be significant if this call is being made a large number of times. See the group.find and group.find.slot functions.

Returns:

b - true if a match was found, false otherwise

Arguments:

z - a zone pointer

iside - side of the zone indicating the face, from 1 to 6

s - the group name to check against.

slot - an optional slot specification; if not given, the slot Default is assumed