SetActorPool

Syntax  

SetActorPool = ActorUID|Identifier(n)|Value(n).....

Description

Complex command that identifies parameters for an in-game Option or Multiple Choice Event. The command activates an option, i.e it allows the interface to show the option to the player. The player will then choose an answer to the option, this answer will be tested with others commands.

Note: ChangeActorPool is the original command syntax, and is still supported. 

Valid identifier parameters are:

  MaxUse = Turns option "on" (= 1) or "off" (= 0).
       To disable the option, SetActorPool should be used with a MaxUse of 0
   
  MaxChoices = Maximum choices (1 for "simple" option, (2 to 4) for Multiple Choice Event)
 
  Title = The Title text shown in the Options ledger.
  ImageID = The graphic image used in the ledger

  SubType = The unique identifier (EventID) for this option or MC Event. 
         (referenced by most of the script commands that apply to the option defined) 

  MsgString = The subtext message appearing in the ledger (if not a MC option)
  ToolString = The "tooltip" appearing in the ledger (if not a MC option)

  TextChoice(1 to 4) = Text for Multiple Choice event choices (only)
  ToolChoice(1 to 4) = Tooltip for Multiple Choice event choices (only)

  Param(1 to 3) = unused
  SParam (1 to 3) = 
       Sparam1 = Faction that will use the option.

Effective with game engine releases dated June 27, 2012 or later:

It is now possible to imbed the costs of an option in the defining SetActorPool command.
The valid assets that are understood are: 
Morale, Money, VP, Prestige, EP, Inflation, Conscript, Warsupply, WSU, Capital, Steel, Coal,
     Good, Goods, Mineral, Oil, Diplomat, Foreignentry 

Additional Parameters used in AACW only

  ResetFreq = Turns to elapse before the option is reset and available again. [DEPRECATED, used in AACW only]
  Money = Cost in Money if option chosen. [reactivated for game engines after 6/27/2012]
  Conscript = Cost in Conscripts if option chosen. [reactivated for game engines after 6/27/2012]
  WarSupply = Cost in War Supply. [reactivated for game engines after 6/27/2012]
  Morale = Cost in Morale. [DEPRECATED]
  VP = Cost in Victory Points. [reactivated for game engines after 6/27/2012]

Example  

SetActorPool = $gmaOptionVar|MaxUse|1|ImageID|Opt_SYW_Contributions.png|
           Title|opt_title_PRU_More_Money|MsgString|opt_desc_PRU_More_Money|
           ToolString|opt_hint_PRU_More_Money|SubType|PRU_More_Money|SParam1|PRU

"Simple" option in gmaOptionVar ledger page. EventID is PRU_More_Money for PRU faction.  

SetActorPool = $gmaMCEvent|MaxUse|1|MaxChoices|3|ImageID|Opt_SYW_Death.png|
              Title|opt_title_PRU_Ferdinand|MsgString|opt_desc_PRU_Ferdinand|
              ToolString|opt_hint_PRU_Ferdinand|SubType|PRU_Ferdinand|SParam1|PRU|
              TextChoice1|opt_PRU_Ferdinand_desc_Choice1|ToolChoice1|opt_PRU_Ferdinand_hint_Choice1|
              TextChoice2|opt_PRU_Ferdinand_desc_Choice2|ToolChoice2|opt_PRU_Ferdinand_hint_Choice2|
              TextChoice3|opt_PRU_Ferdinand_desc_Choice3|ToolChoice3|opt_PRU_Ferdinand_hint_Choice3

Multiple choice event with 3 choices. EventID is PRU_Ferdinand for the PRU faction.

Parameters

ActorUID

Valid gameActor alias

Identifier(n)

Valid identifier. See box at left

Value(n)

Value for the identifier.