group_create(group[, block])

Parameters:
group (string or table) name of the script group, or a group table (should have a "name" field that contains the name of the group)
block (boolean, optional) set to true to block until everything in the group has finished streaming in (defaults to false)
 
Returns:
none

Description:
Creates all script objects belonging to the specified script group.

If the script object is already created, it will reset the script object to initial position and state. The objects will be unhidden by default.

Example:

   group_create("mission 1 characters", true)

Creates all objects in the "mission 1 characters" group and waits for them to stream in.

Notes:
 - before group_create() is called, script objects in the group don�t exist, so they don�t need to be hidden
 - also, this means that any script commands using those script objects must come AFTER the group_create() call; otherwise those commands will do nothing
 - group_create() call should probably go in mission_start() rather than mission_setup(), as in the final game, the player might have several missions open at once

 

back to indexSR3 Script Action Documentation
Last updated: Tue, 09 Aug 2011 11:32:15