Skip to content

join

Syntax

join(group-name)
join(group-name, site-id-expression)

Parameters

group-name
Name of the group being joined
site-id-expression
Site ID of the place being joined

Description

The first form causes the agent to join a random site of the given group type.

The second form causes the agent to join a specific site of the given group type. The specific group that the agent joins is the value of site_id_expression, treated as a unique identifier for a specific site of the group type. This form only applies to places.

If the agent already belongs to group of the given type, the agent first quits that group before joining the specified group. If the group already has maximum size, the action has no effect.

Examples

An agent can enroll in the same school as a friend with:

join(School, ask(my_friend,School))

An agent can join a network with:

join(my_network)

See Also