Due to a sudden burst in spammer activity, account creation has been temporarily disabled. Sorry for the inconvenience to any new potential contributors.
SelUnqSubUnit
From AGEWiki
(Created page with '{{ scriptcommand | name = SelUnqSubUnit | syntax = Name [;Region RgnUID] [;Area AreaUID] [;CondSkip or NoSelGroup] | description = This command sets the Unit Selector to the sele…') |
|||
| Line 3: | Line 3: | ||
| syntax = Name [;Region RgnUID] [;Area AreaUID] [;CondSkip or NoSelGroup] | | syntax = Name [;Region RgnUID] [;Area AreaUID] [;CondSkip or NoSelGroup] | ||
| description = This command sets the Unit Selector to the selected unit, so that following commands can operate on it, i.e. a particular unit of some kind, be it an ordinary unit, a general or a ship. | | description = This command sets the Unit Selector to the selected unit, so that following commands can operate on it, i.e. a particular unit of some kind, be it an ordinary unit, a general or a ship. | ||
| + | |||
| + | Note: The SubUnit can be either an [[Element]] of a basic unit, or a part of a higher level combined group (such as a Division in AACW/NCP or Brigade in RoP). In WIA/BoA, this command will only search for the name of a unique Element, not for the name of a Unit (as in WIA/BoA there are no "higher" groups allowed) | ||
| example = Napoleon; Region $Paris | | example = Napoleon; Region $Paris | ||
| - | | example-description = Select the unit containing Napoleon only if located in the | + | | example-description = Select the unit containing Napoleon only if located in the Region $Paris |
| param1 = Name | | param1 = Name | ||
| - | | param1desc = | + | | param1desc = The SubUnit name (not the Alias) as defined in the Create Unit (as opposed to Model or Unit database) |
| param2 = [;Region RgnUID] or [;Area AreaUID] | | param2 = [;Region RgnUID] or [;Area AreaUID] | ||
| param2desc = Optional. One of these only, to restrict to the specified Region or Area. Valid Region or Area [[Aliases|Alias]] | | param2desc = Optional. One of these only, to restrict to the specified Region or Area. Valid Region or Area [[Aliases|Alias]] | ||
Latest revision as of 11:53, 25 April 2010
SelUnqSubUnit | |||
|
Syntax SelUnqSubUnit = Name [;Region RgnUID] [;Area AreaUID] [;CondSkip or NoSelGroup] Description This command sets the Unit Selector to the selected unit, so that following commands can operate on it, i.e. a particular unit of some kind, be it an ordinary unit, a general or a ship. Note: The SubUnit can be either an Element of a basic unit, or a part of a higher level combined group (such as a Division in AACW/NCP or Brigade in RoP). In WIA/BoA, this command will only search for the name of a unique Element, not for the name of a Unit (as in WIA/BoA there are no "higher" groups allowed) Example SelUnqSubUnit = Napoleon; Region $Paris Select the unit containing Napoleon only if located in the Region $Paris
|
Parameters
The SubUnit name (not the Alias) as defined in the Create Unit (as opposed to Model or Unit database)
Optional. One of these only, to restrict to the specified Region or Area. Valid Region or Area Alias
Optional
| ||
