Due to a sudden burst in spammer activity, account creation has been temporarily disabled. Sorry for the inconvenience to any new potential contributors.

EvalColStatus

From AGEWiki

(Difference between revisions)
Jump to: navigation, search
(Created page with '{{ scriptcommand | name = EvalColStatus | type = | cat = | syntax = <ColAreaUID>;<Operator>;<Status> | description = Evaluate the status of a given colonial area (as per the list…')
 
Line 3: Line 3:
| type =
| type =
| cat =
| cat =
-
| syntax = <ColAreaUID>;<Operator>;<Status>
+
| syntax = <RgnUID>;<Operator>;<Status>
-
| description = Evaluate the status of a given colonial area (as per the list in GameData\ColonialAreas.ini). If there is no faction in selection (this can be achieved by doing a SelectFaction with the [[CMN tag]]), then this will be an absolute test, otherwise this will be relative to the faction in selection.
+
| description = Evaluate the status of a given colonial region. If there is no faction in selection (this can be achieved by doing a SelectFaction with the [[CMN tag]]), then this will be an absolute test, otherwise this will be relative to the faction in selection.
'''Examples:'''
'''Examples:'''
  SelectFaction = FRA
  SelectFaction = FRA
-
  EvalColStatus = $Colony_Algeria{{!}}>={{!}}$colProtectorate
+
  EvalColStatus = $Vinhlong{{!}}>={{!}}$colProtectorate
    
    
-
   Will test if Algeria is under French Protectorate.
+
   Will test if region Vinhlong is under French Protectorate status.
   
   
   
   
  SelectFaction = CMN
  SelectFaction = CMN
-
  EvalColStatus = $Colony_Egypt{{!}}>={{!}}$colInfluenced
+
  EvalColStatus = $Vinhlong{{!}}>={{!}}$colInfluenced
    
    
-
   Will test if Egypt is under the influence of any nation.
+
   Will test if region Vinhlong is under the influence of any nation.
See also [[SetColStatus]]
See also [[SetColStatus]]
Line 23: Line 23:
| example2 =
| example2 =
| example2-description =
| example2-description =
-
| param1 = <ColAreaUID>
+
| param1 = <RgnUID>
-
| param1desc = Valid [[Area]] [[Alias]]  
+
| param1desc = Valid [[Region]] [[Alias]]  
| param2 =<Operator>
| param2 =<Operator>
| param2desc = One of:
| param2desc = One of:

Latest revision as of 08:04, 12 May 2011

EvalColStatus

Syntax   

EvalColStatus = <RgnUID>;<Operator>;<Status>

Description

Evaluate the status of a given colonial region. If there is no faction in selection (this can be achieved by doing a SelectFaction with the CMN tag), then this will be an absolute test, otherwise this will be relative to the faction in selection.

Examples: 

SelectFaction = FRA
EvalColStatus = $Vinhlong|>=|$colProtectorate
 
  Will test if region Vinhlong is under French Protectorate status.


SelectFaction = CMN
EvalColStatus = $Vinhlong|>=|$colInfluenced
 
  Will test if region Vinhlong is under the influence of any nation.

See also SetColStatus



 

Parameters

<RgnUID>

Valid Region Alias

<Operator>

One of:

=, <, >, <=, >=
<Status>

Valid value of status, as defined in GameData\ColonialAreas.ini

Valid values for VGN are:
$colUnknown = -3
$colWild = -2
$colUnclaimed = -1
$colInfluenced = 0
$colProtectorate = 1
$colColony = 2
$colDominion = 3
$colVassal = 3
Retrieved from "http://www.ageod.net/agewiki/EvalColStatus"
Forums