Groups Scripting Extensions


Snoopy Pfeffer's picture

By Snoopy Pfeffer - Posted on 18 March 2012

Groups Scripting Extensions

Dreamland Metaverse provides two additional scripting functions for user groups.

These functions require that the script resides in an object that is set to a group. Beside that the owner of that object has the have the required right for that group. These functions do not work for objects deeded to a group (owned by a group). It is required that an user owns that object.

The following scripting functions can be used to invite or eject group members to/from groups:

  • integer osInviteToGroup(key user)
    Invite the given user to the group the object is set to. The group can be a closed user group.
    Thread level required: VeryLow.
    The object owner must have the right to invite new users to the group the object is set to. The user with the given key has to be online in that region. This is a required limitation to not make group invitation spam possible.
    The user gets a normal group invitation, showing the owner of the object as sender. The invitation can be accepted or rejected and the user can open the corresponding group window. The result is TRUE, if the invitation could be sent, otherwise FALSE.
  • integer osEjectFromGroup(key user)
    Eject the given user from the group the object is set to.
    Thread level required: VeryLow.
    The object owner must have the right to eject users from the group the object is set to.
    The group member who is ejected can be offline. The user gets an instant message, that he/she has been ejected from that group. The result is TRUE, if the user could be ejected, otherwise FALSE.

If you have questions using these scripting extensions, please contact us.