AreaInstanceList

From HEWIKI
Jump to: navigation, search

Contents

Area Instance List

AreaInstanceList(area as ID, instanceList references List of ID)

Arguments

<areat> 
The area ID that is being checked.
<instanceList> 
A returned list of IDs of instances being spun up

Description

Populates a list with the IDs of all the instances that are running for the passed area.

Instances that are spinning up are not included in this list (for those, use Area Attempted Instance List ).

An instance with an ID of 0 is an Edit Instance.

Note: If a script checks for current instances, and then for attempted instances, that will generate a full list of all appropriate instances. It won't be possible for an instance to get "lost" (like being attempted while the current list is being checked, but current while the attempted list is being checked) because the rest of the server halts execution while running a script.

For more information see: Area Server

Example

// The below example would tell you all instances starting up
  area as ID = GetAreaNumber()
  AreaInstanceList(area, areaInstance references list of id)
  foreach instance in areaInstance
    println("Instance: "+instance+" is running.")
  .
.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox