User Login
Name
Password
Site Contents
News
About
Download
Scripts
Tutorials
Register
Support
FAQ
Script Reference
New User


Contact Me
Xide
Online Scripting Reference

getSectorParameter

Purpose
Retrieves a permanent user specified variable that has been assigned to a sector in the TWX Database.

Syntax
getSectorParameter {sectorIndex} {parameterName} var

{sectorIndex}: The index of the sector holding the value to retrieve.

{parameterName}: The search name of the value to retrieve. This can be anything up to 10 characters.

var: A variable to contain the value being retrieved.



Notes
This command can be used to return a value that has been assigned to a sector using the SetSectorParameter command.

If the value is not found, nothing ("") is returned.

For more information, refer to the SetSectorParameter command.

Example
# show all sectors that have been marked as enemy territory

setVar $i 1

while ($i <= SECTORS)
  getSectorParameter $i "Owner" $owner

  if ($owner = "Enemy")
    echo $i "*"
  end
end



Return to item listing