From Ivanius, 1 Year ago, written in XML.
Embed
  1. <?xml version="1.0" encoding="Windows-1252" ?>
  2. <NotepadPlus>
  3.         <!--
  4.         @author Reinhard Hofer aka Strangelove
  5.         @created for KaMRemake Dynamic Script
  6.         @for feedback please go to http://knightsandmerchants.net/forum/viewtopic.php?f=32&t=2722
  7.         @version 0.9.1
  8.         @09.09.2015
  9.         @Edited by Ivanius aka IvaniuS51
  10.         @Changes for adrenaline scripting language
  11.         -->
  12.         <AutoComplete language="pascal">
  13.                 <Environment ignoreCase="no" startFunc="(" stopFunc=")" paramSeparator="," terminal=";" />
  14.                 <!-- Helpers -->
  15.                 <KeyWord name="Integer" />
  16.                 <KeyWord name="Byte" />
  17.                 <KeyWord name="Boolean" />
  18.                 <KeyWord name="Array" />
  19.                 <KeyWord name="Var" />
  20.                 <KeyWord name="Procedure" />
  21.                 <KeyWord name="Function" />
  22.                 <KeyWord name="Begin" />
  23.                 <KeyWord name="Then" />
  24.                 <KeyWord name="End" />
  25.                 <KeyWord name="Else" />
  26.                 <KeyWord name="Case" />
  27.                 <KeyWord name="Break" />
  28.                 <KeyWord name="For" />
  29.                 <KeyWord name="Exit" />
  30.                 <KeyWord name="Record" />
  31.                 <KeyWord name="While" />
  32.                 <KeyWord name="With" />
  33.                 <KeyWord name="Type" />
  34.                 <KeyWord name="inttostr" func="yes">
  35.         <!--Delphi Functions-->
  36.                         <Overload retVal="Integer" descr="Coverts an Integer-Variable into a string. Example: Actions.ShowMsg(-1, 'Sting: ' + inttostr(intVariable))">
  37.                 <Param name="intVariable" />
  38.                 </Overload>
  39.                 </KeyWord>
  40.                 <KeyWord name="SetLength" func="yes">
  41.                         <Overload retVal="Dynamic Array" descr="Sets the length of an Array. Example: var aGroups: array of Integer; SetLength(aGroups, 20);">
  42.                 <Param name="aArray" />
  43.                                 <Param name="Variable" />
  44.                 </Overload>
  45.                 </KeyWord>
  46.                 <KeyWord name="Length" func="yes">
  47.                         <Overload retVal="" descr="Returns the length of an Array.">
  48.                 <Param name="aArray" />
  49.                 </Overload>
  50.                 </KeyWord>
  51.         <!-- ----------- -->
  52.                 <!-- Adrenaline  -->
  53.                 <!-- ----------- -->
  54.         <KeyWord name="MoveTo" func="yes">
  55.             <Overload retVal="State" descr="Return Bollean Result, Try move User to these coordinates">
  56.                 <Param name="X" />
  57.                 <Param name="Y" />
  58.                 <Param name="Z" />
  59.                 <Param name="!TimeOut: Integer" />
  60.             </Overload>
  61.         </KeyWord>
  62.                 <!-- ------- -->
  63.                 <!-- Events  -->
  64.                 <!-- ------- -->
  65.                 <KeyWord name="OnBeacon" func="yes">
  66.                         <Overload retVal="Event" descr="Occurs when a player places a beacon on the map.">
  67.                 <Param name="aPlayerIndex" />
  68.                                 <Param name="aX" />
  69.                                 <Param name="aY: Integer" />
  70.                 </Overload>
  71.                 </KeyWord>
  72.                 <KeyWord name="OnHouseAfterDestroyed" func="yes">
  73.                         <Overload retVal="Event" descr="Occurs after a house is destroyed and has been completely removed from the game, meaning the area it previously occupied can be used. If you need more information about the house use the !OnHouseDestroyed event.">
  74.                 <Param name="aHouseType" />
  75.                                 <Param name="aOwner" />
  76.                                 <Param name="aX" />
  77.                                 <Param name="aY: Integer" />
  78.                 </Overload>
  79.                 </KeyWord>
  80.                 <KeyWord name="OnHouseBuilt" func="yes">
  81.                         <Overload retVal="Event" descr="Occurs when player has built a house.">
  82.                 <Param name="aHouseID: Integer" />
  83.                 </Overload>
  84.                 </KeyWord>
  85.                 <KeyWord name="OnHouseDamaged" func="yes">
  86.                         <Overload retVal="Event" descr="Occurs when a house is damaged by the enemy soldier. If !AttackerIndex is -1 the house was damaged some other way, such as from Actions.!HouseAddDamage.">
  87.                 <Param name="aHouseID" />
  88.                                 <Param name="aAttackerIndex: Integer" />
  89.                 </Overload>
  90.                 </KeyWord>
  91.                 <KeyWord name="OnHouseDestroyed" func="yes">
  92.                         <Overload retVal="Event" descr="Occurs when a house is destroyed. If !DestroyerIndex is -1 the house was destroyed some other way, such as from Actions.!HouseDestroy. If !DestroyerIndex is the same as the house owner (States.!HouseOwner), the house was demolished by the player who owns it. Otherwise it was destroyed by an enemy. Called just before the house is destroyed so HouseID is usable only during this event, and the area occupied by the house is still unusable.">
  93.                 <Param name="aHouseID" />
  94.                                 <Param name="aDestroyerIndex: Integer" />
  95.                 </Overload>
  96.                 </KeyWord>
  97.                 <KeyWord name="OnHousePlanPlaced" func="yes">
  98.                         <Overload retVal="Event" descr="Occurs when player has placed a house plan.">
  99.                 <Param name="aPlayerIndex" />
  100.                                 <Param name="X" />
  101.                                 <Param name="Y" />
  102.                                 <Param name="aHouseType: Integer" />
  103.                 </Overload>
  104.                 </KeyWord>
  105.                 <KeyWord name="OnHousePlanRemoved" func="yes">
  106.                         <Overload retVal="Event" descr="Occurs when player has removed a house plan.">
  107.                 <Param name="aPlayerIndex" />
  108.                                 <Param name="X" />
  109.                                 <Param name="Y" />
  110.                                 <Param name="aHouseType: Integer" />
  111.                 </Overload>
  112.                 </KeyWord>
  113.                 <KeyWord name="OnGroupHungry" func="yes">
  114.                         <Overload retVal="Event" descr="Occurs when the player would be shown a message about a group being hungry (when they first get hungry, then every 4 minutes after that if there are still hungry group members). Occurs regardless of whether the group has hunger messages enabled or not.">
  115.                 <Param name="aGroupID: Integer" />
  116.                 </Overload>
  117.                 </KeyWord>
  118.                 <KeyWord name="OnMarketTrade" func="yes">
  119.                         <Overload retVal="Event" descr="Occurs when a trade happens in a market (at the moment when resources are exchanged by serfs).">
  120.                 <Param name="aHouseID" />
  121.                                 <Param name="aFromWare" />
  122.                                 <Param name="aToWare: Integer" />
  123.                 </Overload>
  124.                 </KeyWord>
  125.                 <KeyWord name="OnMissionStart" func="yes">
  126.                         <Overload retVal="Event" descr="Occurs immediately after the mission is loaded.">
  127.                 </Overload>
  128.                 </KeyWord>
  129.                 <KeyWord name="OnPlanRoadPlaced" func="yes">
  130.                         <Overload retVal="Event" descr="Occurs when a player places a road plan.">
  131.                 <Param name="aIndex" />
  132.                                 <Param name="X" />
  133.                                 <Param name="Y: Integer" />
  134.                 </Overload>
  135.                 </KeyWord>
  136.                 <KeyWord name="OnPlanRoadRemoved" func="yes">
  137.                         <Overload retVal="Event" descr="Occurs when a player removes a road plan.">
  138.                 <Param name="aIndex" />
  139.                                 <Param name="X" />
  140.                                 <Param name="Y: Integer" />
  141.                 </Overload>
  142.                 </KeyWord>
  143.                 <KeyWord name="OnPlanFieldPlaced" func="yes">
  144.                         <Overload retVal="Event" descr="Occurs when a player places a field plan.">
  145.                 <Param name="aIndex" />
  146.                                 <Param name="X" />
  147.                                 <Param name="Y: Integer" />
  148.                 </Overload>
  149.                 </KeyWord>
  150.                 <KeyWord name="OnPlanFieldRemoved" func="yes">
  151.                         <Overload retVal="Event" descr="Occurs when a player removes a field plan.">
  152.                 <Param name="aIndex" />
  153.                                 <Param name="X" />
  154.                                 <Param name="Y: Integer" />
  155.                 </Overload>
  156.                 </KeyWord>
  157.                 <KeyWord name="OnPlanWinefieldPlaced" func="yes">
  158.                         <Overload retVal="Event" descr="Occurs when a player places a winefield plan.">
  159.                 <Param name="aIndex" />
  160.                                 <Param name="X" />
  161.                                 <Param name="Y: Integer" />
  162.                 </Overload>
  163.                 </KeyWord>
  164.                 <KeyWord name="OnPlanWinefieldRemoved" func="yes">
  165.                         <Overload retVal="Event" descr="Occurs when a player removes a winefield plan.">
  166.                 <Param name="aIndex" />
  167.                                 <Param name="X" />
  168.                                 <Param name="Y: Integer" />
  169.                 </Overload>
  170.                 </KeyWord>
  171.                 <KeyWord name="OnPlayerDefeated" func="yes">
  172.                         <Overload retVal="Event" descr="Occurs when certain player has been defeated. Defeat conditions are checked separately by Player AI.">
  173.                                 <Param name="aIndex: Integer" />
  174.                 </Overload>
  175.                 </KeyWord>
  176.                 <KeyWord name="OnPlayerVictory" func="yes">
  177.                         <Overload retVal="Event" descr="Occurs when certain player is declared victorious. Victory conditions are checked separately by Player AI.">
  178.                                 <Param name="aIndex: Integer" />
  179.                 </Overload>
  180.                 </KeyWord>
  181.                 <KeyWord name="OnTick" func="yes">
  182.                         <Overload retVal="Event" descr="Occurs every game logic update.">
  183.                 </Overload>
  184.                 </KeyWord>
  185.                 <KeyWord name="OnUnitAfterDied" func="yes">
  186.                         <Overload retVal="Event" descr="Occurs after a unit has died and has been completely removed from the game, meaning the tile it previously occupied can be used. If you need more information about the unit use the !OnUnitDied event. Note: Because units have a death animation there is a delay of several ticks between !OnUnitDied and !OnUnitAfterDied.">
  187.                 <Param name="aUnitType" />
  188.                                 <Param name="aOwner" />
  189.                                 <Param name="aX" />
  190.                                 <Param name="aY: Integer" />
  191.                 </Overload>
  192.                 </KeyWord>
  193.                 <KeyWord name="OnUnitAttacked" func="yes">
  194.                         <Overload retVal="Event" descr="Happens when a unit is attacked (shot at by archers or hit in melee). Attacker is always a warrior (could be archer or melee). This event will occur very frequently during battles.">
  195.                 <Param name="aUnitID" />
  196.                                 <Param name="AttackerID: Integer" />
  197.                 </Overload>
  198.                 </KeyWord>
  199.                 <KeyWord name="OnUnitDied" func="yes">
  200.                         <Overload retVal="Event" descr="Occurs when a unit dies. If !KillerIndex is -1 the unit died from another cause such as hunger or Actions.!UnitKill. Called just before the unit is killed so UnitID is usable only during this event, and the tile occupied by the unit is still taken.">
  201.                 <Param name="aUnitID" />
  202.                                 <Param name="aKillerIndex: Integer" />
  203.                 </Overload>
  204.                 </KeyWord>
  205.                 <KeyWord name="OnUnitTrained" func="yes">
  206.                         <Overload retVal="Event" descr="Occurs when player trains a unit.">
  207.                 <Param name="aUnitID: Integer" />
  208.                 </Overload>
  209.                 </KeyWord>
  210.                 <KeyWord name="OnUnitWounded" func="yes">
  211.                         <Overload retVal="Event" descr="Happens when unit is wounded. Attacker can be a warrior, recruit in tower or unknown (-1).">
  212.                 <Param name="aUnitID" />
  213.                                 <Param name="AttackerID: Integer" />
  214.                 </Overload>
  215.                 </KeyWord>
  216.                 <KeyWord name="OnWarriorEquipped" func="yes">
  217.                         <Overload retVal="Event" descr="Occurs when player equips a warrior.">
  218.                 <Param name="aUnitID" />
  219.                                 <Param name="aGroupID: Integer" />
  220.                 </Overload>
  221.                 </KeyWord>
  222.                 <!-- Event-Related -->
  223.                 <KeyWord name="aPlayerIndex" />
  224.                 <KeyWord name="aHouseID" />
  225.                 <KeyWord name="aIndex" />
  226.                 <KeyWord name="aHouseType" />
  227.                 <KeyWord name="aOwner" />
  228.                 <KeyWord name="aAttackerIndex" />
  229.                 <KeyWord name="aDestroyerIndex" />
  230.                 <KeyWord name="aGroupID" />
  231.                 <KeyWord name="aFromWare" />
  232.                 <KeyWord name="aToWare" />
  233.                 <KeyWord name="aUnitType" />
  234.                 <KeyWord name="aKillerIndex" />
  235.                 <KeyWord name="AttackerID" />
  236.                 <KeyWord name="aUnitID" />
  237.                 <!-- ------- -->
  238.                 <!-- States  -->
  239.                 <!-- ------- -->
  240.                 <KeyWord name="States." />
  241.                 <KeyWord name="ClosestGroup" func="yes">
  242.                         <Overload retVal="State" descr="Returns the group of the specified player and group type that is closest to the specified coordinates, or -1 if no such group was found. If the group type is -1 any group type will be accepted.">
  243.                 <Param name="Player Index" />
  244.                                 <Param name="X" />
  245.                                 <Param name="Y" />
  246.                                 <Param name="Group Type" />
  247.                 </Overload>
  248.                 </KeyWord>
  249.                 <KeyWord name="ClosestHouse" func="yes">
  250.                         <Overload retVal="State" descr="Returns the house of the specified player and house type that is closest to the specified coordinates, or -1 if no such house was found. If the house type is -1 any house type will be accepted.">
  251.                 <Param name="Player Index" />
  252.                                 <Param name="X" />
  253.                                 <Param name="Y" />
  254.                                 <Param name="House Type" />
  255.                 </Overload>
  256.                 </KeyWord>
  257.                 <KeyWord name="ClosestUnit" func="yes">
  258.                         <Overload retVal="State" descr="Returns the unit of the specified player and unit type that is closest to the specified coordinates, or -1 if no such unit was found. If the unit type is -1 any unit type will be accepted.">
  259.                 <Param name="Player Index" />
  260.                                 <Param name="X" />
  261.                                 <Param name="Y" />
  262.                                 <Param name="Unit Type" />
  263.                 </Overload>
  264.                 </KeyWord>
  265.                 <KeyWord name="ClosestGroupMultipleTypes" func="yes">
  266.                         <Overload retVal="State" descr="Returns the group of the specified player and group types that is closest to the specified coordinates, or -1 if no such group was found. The group types is a 'set of Byte', for example [1,3].">
  267.                 <Param name="Player Index" />
  268.                                 <Param name="X" />
  269.                                 <Param name="Y" />
  270.                                 <Param name="Group Types" />
  271.                 </Overload>
  272.                 </KeyWord>
  273.                 <KeyWord name="ClosestHouseMultipleTypes" func="yes">
  274.                         <Overload retVal="State" descr="Returns the house of the specified player and house types that is closest to the specified coordinates, or -1 if no such house was found. The house types is a 'set of Byte', for example [11,13,21].">
  275.                 <Param name="Player Index" />
  276.                                 <Param name="X" />
  277.                                 <Param name="Y" />
  278.                                 <Param name="House Types" />
  279.                 </Overload>
  280.                 </KeyWord>
  281.                 <KeyWord name="ClosestUnitMultipleTypes" func="yes">
  282.                         <Overload retVal="State" descr="Returns the unit of the specified player and unit types that is closest to the specified coordinates, or -1 if no such unit was found. The unit types is a 'set of Byte', for example [0,9].">
  283.                 <Param name="Player Index" />
  284.                                 <Param name="X" />
  285.                                 <Param name="Y" />
  286.                                 <Param name="Unit Types" />
  287.                 </Overload>
  288.                 </KeyWord>
  289.                 <KeyWord name="ConnectedByRoad" func="yes">
  290.                         <Overload retVal="State" descr="Check if two tiles are connected by walkable road.">
  291.                 <Param name="X1" />
  292.                                 <Param name="Y1" />
  293.                                 <Param name="X2" />
  294.                                 <Param name="Y2" />
  295.                 </Overload>
  296.                 </KeyWord>
  297.                 <KeyWord name="ConnectedByWalking" func="yes">
  298.                         <Overload retVal="State" descr="Check if two tiles are connected by a walkable route.">
  299.                 <Param name="X1" />
  300.                                 <Param name="Y1" />
  301.                                 <Param name="X2" />
  302.                                 <Param name="Y2" />
  303.                 </Overload>
  304.                 </KeyWord>
  305.                 <KeyWord name="FogRevealed" func="yes">
  306.                         <Overload retVal="State" descr="Check if a tile is revealed in fog of war for a player.">
  307.                 <Param name="Player Index" />
  308.                                 <Param name="X" />
  309.                                 <Param name="Y" />
  310.                 </Overload>
  311.                 </KeyWord>
  312.                 <KeyWord name="GameTime" func="yes">
  313.                         <Overload retVal="State" descr="Get the number of game ticks since mission start.">
  314.                 </Overload>
  315.                 </KeyWord>
  316.                 <KeyWord name="GroupAt" func="yes">
  317.                         <Overload retVal="State" descr="Returns the ID of the group of the unit on the specified tile or -1 if no group exists there.">
  318.                                 <Param name="X" />
  319.                                 <Param name="Y" />
  320.                 </Overload>
  321.                 </KeyWord>
  322.                 <KeyWord name="GroupColumnCount" func="yes">
  323.                         <Overload retVal="State" descr="Returns the number of columns (units per row) of the specified group.">
  324.                                 <Param name="Group ID" />
  325.                 </Overload>
  326.                 </KeyWord>
  327.                 <KeyWord name="GroupDead" func="yes">
  328.                         <Overload retVal="State" descr="Returns true if the group is dead (all members dead or joined other groups).">
  329.                                 <Param name="Group ID" />
  330.                 </Overload>
  331.                 </KeyWord>
  332.                 <KeyWord name="GroupIdle" func="yes">
  333.                         <Overload retVal="State" descr="Returns true if specified group is idle (has no orders/action).">
  334.                                 <Param name="Group ID" />
  335.                 </Overload>
  336.                 </KeyWord>
  337.                 <KeyWord name="GroupMember" func="yes">
  338.                         <Overload retVal="State" descr="Returns the unit ID of the specified group member. Member 0 will be the flag holder, 1...!GroupMemberCount-1 will be the other members (0 <= !MemberIndex <= !GroupMemberCount-1).">
  339.                                 <Param name="Group ID" />
  340.                                 <Param name="Member Index" />
  341.                 </Overload>
  342.                 </KeyWord>
  343.                 <KeyWord name="GroupMemberCount" func="yes">
  344.                         <Overload retVal="State" descr="Returns the total number of members of the specified group.">
  345.                                 <Param name="Group ID" />
  346.                 </Overload>
  347.                 </KeyWord>
  348.                 <KeyWord name="GroupOwner" func="yes">
  349.                         <Overload retVal="State" descr="Returns the owner of the specified group or -1 if Group ID invalid.">
  350.                                 <Param name="Group ID" />
  351.                 </Overload>
  352.                 </KeyWord>
  353.                 <KeyWord name="GroupType" func="yes">
  354.                         <Overload retVal="State" descr="Returns the type of the specified group or -1 if Group ID invalid.">
  355.                                 <Param name="Group ID" />
  356.                 </Overload>
  357.                 </KeyWord>
  358.                 <KeyWord name="HouseAt" func="yes">
  359.                         <Overload retVal="State" descr="Returns the ID of the house at the specified location or -1 if no house exists there.">
  360.                                 <Param name="X" />
  361.                                 <Param name="Y" />
  362.                 </Overload>
  363.                 </KeyWord>
  364.                 <KeyWord name="HouseBarracksRallyPointX" func="yes">
  365.                         <Overload retVal="State" descr="Returns X coordinate of Rally Point of specified barracks or 0 if BarracksID is invalid.">
  366.                                 <Param name="Barracks ID" />
  367.                 </Overload>
  368.                 </KeyWord>
  369.                 <KeyWord name="HouseBarracksRallyPointY" func="yes">
  370.                         <Overload retVal="State" descr="Returns Y coordinate of Rally Point of specified barracks or 0 if BarracksID is invalid.">
  371.                                 <Param name="Barracks ID" />
  372.                 </Overload>
  373.                 </KeyWord>
  374.                 <KeyWord name="HouseBuildingProgress" func="yes">
  375.                         <Overload retVal="State" descr="Returns building progress of the specified house.">
  376.                                 <Param name="House ID" />
  377.                 </Overload>
  378.                 </KeyWord>
  379.                 <KeyWord name="HouseCanReachResources" func="yes">
  380.                         <Overload retVal="State" descr="Returns true if the specified house can reach the resources that it mines (coal, stone, fish, etc.).">
  381.                                 <Param name="House ID" />
  382.                 </Overload>
  383.                 </KeyWord>
  384.                 <KeyWord name="HouseDamage" func="yes">
  385.                         <Overload retVal="State" descr="Returns the damage of the specified house or -1 if House ID invalid.">
  386.                                 <Param name="House ID" />
  387.                 </Overload>
  388.                 </KeyWord>
  389.                 <KeyWord name="HouseDeliveryBlocked" func="yes">
  390.                         <Overload retVal="State" descr="Returns true if the specified house has delivery disabled.">
  391.                                 <Param name="House ID" />
  392.                 </Overload>
  393.                 </KeyWord>
  394.                 <KeyWord name="HouseDestroyed" func="yes">
  395.                         <Overload retVal="State" descr="Returns true if the house is destroyed.">
  396.                                 <Param name="House ID" />
  397.                 </Overload>
  398.                 </KeyWord>
  399.                 <KeyWord name="HouseHasOccupant" func="yes">
  400.                         <Overload retVal="State" descr="Returns true if the specified house currently has an occupant.">
  401.                                 <Param name="House ID" />
  402.                 </Overload>
  403.                 </KeyWord>
  404.                 <KeyWord name="HouseIsComplete" func="yes">
  405.                         <Overload retVal="State" descr="Returns true if the specified house is fully built.">
  406.                                 <Param name="House ID" />
  407.                 </Overload>
  408.                 </KeyWord>
  409.                 <KeyWord name="HouseTypeMaxHealth" func="yes">
  410.                         <Overload retVal="State" descr="Returns max health of the specified house type.">
  411.                                 <Param name="House Type" />
  412.                 </Overload>
  413.                 </KeyWord>
  414.                 <KeyWord name="HouseTypeToOccupantType" func="yes">
  415.                         <Overload retVal="State" descr="Returns the type of unit that should occupy the specified type of house, or -1 if no unit should occupy it.">
  416.                                 <Param name="House ID" />
  417.                 </Overload>
  418.                 </KeyWord>
  419.                 <KeyWord name="HouseOwner" func="yes">
  420.                         <Overload retVal="State" descr="Returns the owner of the specified house or -1 if House ID invalid.">
  421.                                 <Param name="House ID" />
  422.                 </Overload>
  423.                 </KeyWord>
  424.                 <KeyWord name="HousePositionX" func="yes">
  425.                         <Overload retVal="State" descr="Returns the X coordinate of the specified house or -1 if House ID invalid.">
  426.                                 <Param name="House ID" />
  427.                 </Overload>
  428.                 </KeyWord>
  429.                 <KeyWord name="HousePositionY" func="yes">
  430.                         <Overload retVal="State" descr="Returns the Y coordinate of the specified house or -1 if House ID invalid.">
  431.                                 <Param name="House ID" />
  432.                 </Overload>
  433.                 </KeyWord>
  434.                 <KeyWord name="HouseRepair" func="yes">
  435.                         <Overload retVal="State" descr="Returns true if the specified house has repair enabled.">
  436.                                 <Param name="House ID" />
  437.                 </Overload>
  438.                 </KeyWord>
  439.                 <KeyWord name="HouseResourceAmount" func="yes">
  440.                         <Overload retVal="State" descr="Returns the amount of the specified resource in the specified house.">
  441.                                 <Param name="House ID" />
  442.                                 <Param name="Recource Type" />
  443.                 </Overload>
  444.                 </KeyWord>
  445.                 <KeyWord name="HouseSchoolQueue" func="yes">
  446.                         <Overload retVal="State" descr="Returns the unit type in the specified slot of the school queue. Slot 0 is the unit currently training, slots 1..5 are the queue.">
  447.                                 <Param name="House ID" />
  448.                                 <Param name="Slot" />
  449.                 </Overload>
  450.                 </KeyWord>
  451.                 <KeyWord name="HouseSiteIsDigged" func="yes">
  452.                         <Overload retVal="State" descr="Returns true if specified WIP house area is digged.">
  453.                                 <Param name="House ID" />
  454.                 </Overload>
  455.                 </KeyWord>
  456.                 <KeyWord name="HouseType" func="yes">
  457.                         <Overload retVal="State" descr="Returns the type of the specified house.">
  458.                                 <Param name="House ID" />
  459.                 </Overload>
  460.                 </KeyWord>
  461.                 <KeyWord name="HouseTypeName" func="yes">
  462.                         <Overload retVal="State" descr="Returns the the translated name of the specified house type. Note: To ensure multiplayer consistency the name is returned as a number encoded within a markup which is decoded on output, not the actual translated text. Therefore string operations like !LowerCase will not work.">
  463.                                 <Param name="House Type" />
  464.                 </Overload>
  465.                 </KeyWord>
  466.                 <KeyWord name="HouseUnlocked" func="yes">
  467.                         <Overload retVal="State" descr="Returns true if the specified player can build the specified house type (unlocked and allowed).">
  468.                                 <Param name="Player Index" />
  469.                                 <Param name="House Type" />
  470.                 </Overload>
  471.                 </KeyWord>
  472.                 <KeyWord name="HouseWareBlocked" func="yes">
  473.                         <Overload retVal="State" descr="Returns true if the specified ware in the specified storehouse or barracks is blocked.">
  474.                                 <Param name="House ID" />
  475.                                 <Param name="Ware Type" />
  476.                 </Overload>
  477.                 </KeyWord>
  478.                 <KeyWord name="HouseWeaponsOrdered" func="yes">
  479.                         <Overload retVal="State" descr="Returns the number of the specified weapon ordered to be produced in the specified house.">
  480.                                 <Param name="House ID" />
  481.                                 <Param name="Ware Type" />
  482.                 </Overload>
  483.                 </KeyWord>
  484.                 <KeyWord name="HouseWoodcutterChopOnly" func="yes">
  485.                         <Overload retVal="State" descr="Returns true if the specified woodcutter's hut is on chop-only mode.">
  486.                                 <Param name="House ID" />
  487.                 </Overload>
  488.                 </KeyWord>
  489.                 <KeyWord name="IsFieldAt" func="yes">
  490.                         <Overload retVal="State" descr="Returns true if the specified player has a corn field at the specified location. If player index is -1 it will return true if any player has a corn field at the specified tile.">
  491.                                 <Param name="Player Index" />
  492.                                 <Param name="X" />
  493.                                 <Param name="Y" />
  494.                 </Overload>
  495.                 </KeyWord>
  496.                 <KeyWord name="IsWinefieldAt" func="yes">
  497.                         <Overload retVal="State" descr="Returns true if the specified player has a winefield at the specified location. If player index is -1 it will return true if any player has a winefield at the specified tile.">
  498.                                 <Param name="Player Index" />
  499.                                 <Param name="X" />
  500.                                 <Param name="Y" />
  501.                 </Overload>
  502.                 </KeyWord>
  503.                 <KeyWord name="IsRoadAt" func="yes">
  504.                         <Overload retVal="State" descr="Returns true if the specified player has a road at the specified location. If player index is -1 it will return true if any player has a road at the specified tile.">
  505.                                 <Param name="Player Index" />
  506.                                 <Param name="X" />
  507.                                 <Param name="Y" />
  508.                 </Overload>
  509.                 </KeyWord>
  510.                 <KeyWord name="KaMRandom" func="yes">
  511.                         <Overload retVal="State" descr="Returns a random single (float) such that: 0 <= Number < 1.0.">
  512.                 </Overload>
  513.                 </KeyWord>
  514.                 <KeyWord name="KaMRandomI" func="yes">
  515.                         <Overload retVal="State" descr="Returns a random integer such that: 0 <= Number < !LimitPlusOne.">
  516.                                 <Param name="!LimitPlusOne" />
  517.                 </Overload>
  518.                 </KeyWord>
  519.                 <KeyWord name="LocationCount" func="yes">
  520.                         <Overload retVal="State" descr="Returns the number of player locations available on the map (including AIs), regardless of whether the location was taken in multiplayer (use !PlayerEnabled to check if a location is being used).">
  521.                 </Overload>
  522.                 </KeyWord>
  523.                 <KeyWord name="MapTileHeight" func="yes">
  524.                         <Overload retVal="State" descr="Returns the height of the terrain at the top left corner (vertex) of the tile at the specified XY coordinates. Return value range is 0..100.">
  525.                                 <Param name="X" />
  526.                                 <Param name="Y" />
  527.                 </Overload>
  528.                 </KeyWord>
  529.                 <KeyWord name="MapTileObject" func="yes">
  530.                         <Overload retVal="State" descr="Returns the terrain object ID on the tile at the specified XY coordinates. Object IDs can be seen in the map editor on the objects tab. Object 61 is 'block walking'. Return value range is 0..255. If there is no object on the tile, the result will be 255.">
  531.                                 <Param name="X" />
  532.                                 <Param name="Y" />
  533.                 </Overload>
  534.                 </KeyWord>
  535.                 <KeyWord name="MapTileRotation" func="yes">
  536.                         <Overload retVal="State" descr="Returns the rotation of the tile at the specified XY coordinates. Return value range is 0..3.">
  537.                                 <Param name="X" />
  538.                                 <Param name="Y" />
  539.                 </Overload>
  540.                 </KeyWord>
  541.                 <KeyWord name="MapTileType" func="yes">
  542.                         <Overload retVal="State" descr="Returns the tile type ID of the tile at the specified XY coordinates. Tile IDs can be seen by hovering over the tiles on the terrain tiles tab in the map editor. Return value range is 0..255.">
  543.                                 <Param name="X" />
  544.                                 <Param name="Y" />
  545.                 </Overload>
  546.                 </KeyWord>
  547.                 <KeyWord name="MapWidth" func="yes">
  548.                         <Overload retVal="State" descr="Returns the width of the map.">
  549.                 </Overload>
  550.                 </KeyWord>
  551.                 <KeyWord name="MapHeight" func="yes">
  552.                         <Overload retVal="State" descr="Returns the height of the map.">
  553.                 </Overload>
  554.                 </KeyWord>
  555.                 <KeyWord name="MarketFromWare" func="yes">
  556.                         <Overload retVal="State" descr="Returns type of !FromWare in specified market, or -1 if no ware is selected.">
  557.                                 <Param name="Market ID" />
  558.                 </Overload>
  559.                 </KeyWord>
  560.                 <KeyWord name="MarketLossFactor" func="yes">
  561.                         <Overload retVal="State" descr="Returns the factor of resources lost during market trading, used to calculate the !TradeRatio (see explanation in MarketValue). This value is constant within one KaM Remake release, but may change in future KaM Remake releases.">
  562.                 </Overload>
  563.                 </KeyWord>
  564.                 <KeyWord name="MarketOrderAmount" func="yes">
  565.                         <Overload retVal="State" descr="Returns trade order amount in specified market.">
  566.                                 <Param name="Market ID" />
  567.                 </Overload>
  568.                 </KeyWord>
  569.                 <KeyWord name="MarketToWare" func="yes">
  570.                         <Overload retVal="State" descr="Returns type of !ToWare in specified market, or -1 if no ware is selected.">
  571.                                 <Param name="Market ID" />
  572.                 </Overload>
  573.                 </KeyWord>
  574.                 <KeyWord name="MarketValue" func="yes">
  575.                         <Overload retVal="State" descr="Returns the relative market value of the specified resource type, which is a rough indication of the cost to produce that resource. These values are constant within one KaM Remake release, but may change in future KaM Remake releases. The !TradeRatio is calculated as: MarketLossFactor * MarketValue(To) / (MarketValue(From). If the !TradeRatio is >= 1, then the number of From resources required to receive 1 To resource is: Round(TradeRatio). If the trade ratio is < 1 then the number of To resources received for trading 1 From resource is: Round(1 / TradeRatio).">
  576.                                 <Param name="Resource Type" />
  577.                 </Overload>
  578.                 </KeyWord>
  579.                 <KeyWord name="PeaceTime" func="yes">
  580.                         <Overload retVal="State" descr="Length of peacetime in ticks (multiplayer).">
  581.                 </Overload>
  582.                 </KeyWord>
  583.                 <KeyWord name="PlayerAllianceCheck" func="yes">
  584.                         <Overload retVal="State" descr="Check how player 1 feels towards player 2 (order matters). Returns true for ally, false for enemy.">
  585.                                 <Param name="Player Index" />
  586.                                 <Param name="Player Index" />
  587.                 </Overload>
  588.                 </KeyWord>
  589.                 <KeyWord name="PlayerColorText" func="yes">
  590.                         <Overload retVal="State" descr="Get players color as text in hex format.">
  591.                                 <Param name="Player Index" />
  592.                 </Overload>
  593.                 </KeyWord>
  594.                 <KeyWord name="PlayerDefeated" func="yes">
  595.                         <Overload retVal="State" descr="See if player was defeated.">
  596.                                 <Param name="Player Index" />
  597.                 </Overload>
  598.                 </KeyWord>
  599.                 <KeyWord name="PlayerEnabled" func="yes">
  600.                         <Overload retVal="State" descr="Will be false if nobody selected that location in multiplayer.">
  601.                                 <Param name="Player Index" />
  602.                 </Overload>
  603.                 </KeyWord>
  604.                 <KeyWord name="PlayerGetAllUnits" func="yes">
  605.                         <Overload retVal="State" descr="Returns an array with IDs for all the units of the specified player.">
  606.                                 <Param name="Player Index" />
  607.                 </Overload>
  608.                 </KeyWord>
  609.                 <KeyWord name="PlayerGetAllHouses" func="yes">
  610.                         <Overload retVal="State" descr="Returns an array with IDs for all the houses of the specified player.">
  611.                                 <Param name="Player Index" />
  612.                 </Overload>
  613.                 </KeyWord>
  614.                 <KeyWord name="PlayerGetAllGroups" func="yes">
  615.                         <Overload retVal="State" descr="Returns an array with IDs for all the groups of the specified player.">
  616.                                 <Param name="Player Index" />
  617.                 </Overload>
  618.                 </KeyWord>
  619.                 <KeyWord name="PlayerIsAI" func="yes">
  620.                         <Overload retVal="State" descr="Wherever player is controlled by AI.">
  621.                                 <Param name="Player Index" />
  622.                 </Overload>
  623.                 </KeyWord>
  624.                 <KeyWord name="PlayerName" func="yes">
  625.                         <Overload retVal="State" descr="Get name of player as a string (for multiplayer).">
  626.                                 <Param name="Player Index" />
  627.                 </Overload>
  628.                 </KeyWord>
  629.                 <KeyWord name="PlayerVictorious" func="yes">
  630.                         <Overload retVal="State" descr="See if player is victorious.">
  631.                                 <Param name="Player Index" />
  632.                 </Overload>
  633.                 </KeyWord>
  634.                 <KeyWord name="PlayerWareDistribution" func="yes">
  635.                         <Overload retVal="State" descr="Returns the ware distribution for the specified resource, house and player.">
  636.                                 <Param name="Player Index" />
  637.                                 <Param name="Recource Type" />
  638.                                 <Param name="House Type" />
  639.                 </Overload>
  640.                 </KeyWord>
  641.                 <KeyWord name="StatAIDefencePositionsCount" func="yes">
  642.                         <Overload retVal="State" descr="How many defence positions AI player has. Useful for scripts like 'if not enough positions and too much groups then add a new position'.">
  643.                                 <Param name="Player Index" />
  644.                 </Overload>
  645.                 </KeyWord>
  646.                 <KeyWord name="StatArmyCount" func="yes">
  647.                         <Overload retVal="State" descr="How many military units player has.">
  648.                                 <Param name="Player Index" />
  649.                 </Overload>
  650.                 </KeyWord>
  651.                 <KeyWord name="StatCitizenCount" func="yes">
  652.                         <Overload retVal="State" descr="How many citizen player has.">
  653.                                 <Param name="Player Index" />
  654.                 </Overload>
  655.                 </KeyWord>
  656.                 <KeyWord name="StatHouseMultipleTypesCount" func="yes">
  657.                         <Overload retVal="State" descr="Returns number of specified house types for specified player. Types is a set of byte, f.e. [11, 13, 21].">
  658.                                 <Param name="Player Index" />
  659.                                 <Param name="Types - Set of Byte" />
  660.                 </Overload>
  661.                 </KeyWord>
  662.                 <KeyWord name="StatHouseTypeCount" func="yes">
  663.                         <Overload retVal="State" descr="Specified house type count.">
  664.                                 <Param name="Player Index" />
  665.                                 <Param name="House Type" />
  666.                 </Overload>
  667.                 </KeyWord>
  668.                 <KeyWord name="StatHouseTypePlansCount" func="yes">
  669.                         <Overload retVal="State" descr="Specified house type plans count.">
  670.                                 <Param name="Player Index" />
  671.                                 <Param name="House Type" />
  672.                 </Overload>
  673.                 </KeyWord>
  674.                 <KeyWord name="StatPlayerCount" func="yes">
  675.                         <Overload retVal="State" descr="How many active players there are.">
  676.                 </Overload>
  677.                 </KeyWord>
  678.                 <KeyWord name="StatResourceProducedCount" func="yes">
  679.                         <Overload retVal="State" descr="Returns the number of the specified resource produced by the specified player.">
  680.                                 <Param name="Player Index" />
  681.                                 <Param name="Recource Type" />
  682.                 </Overload>
  683.                 </KeyWord>
  684.                 <KeyWord name="StatUnitCount" func="yes">
  685.                         <Overload retVal="State" descr="Returns the number of units of the specified player.">
  686.                                 <Param name="Player Index" />
  687.                 </Overload>
  688.                 </KeyWord>
  689.                 <KeyWord name="StatUnitKilledCount" func="yes">
  690.                         <Overload retVal="State" descr="Returns the number of the specified unit killed by the specified player.">
  691.                                 <Param name="Player Index" />
  692.                                 <Param name="Unit Type" />
  693.                 </Overload>
  694.                 </KeyWord>
  695.                 <KeyWord name="StatUnitKilledMultipleTypesCount" func="yes">
  696.                         <Overload retVal="State" descr="Returns the number of the specified unit types killed by the specified player. Types is a set of byte, f.e. [0, 5, 13].">
  697.                                 <Param name="Player Index" />
  698.                                 <Param name="Unit Types - Set of Byte" />
  699.                 </Overload>
  700.                 </KeyWord>
  701.                 <KeyWord name="StatUnitLostCount" func="yes">
  702.                         <Overload retVal="State" descr="Returns the number of the specified unit lost by the specified player.">
  703.                                 <Param name="Player Index" />
  704.                                 <Param name="Unit Type" />
  705.                 </Overload>
  706.                 </KeyWord>
  707.                 <KeyWord name="StatUnitLostMultipleTypesCount" func="yes">
  708.                         <Overload retVal="State" descr="Returns the number of the specified unit types lost by the specified player. Types is a set of byte, f.e. [0, 5, 13].">
  709.                                 <Param name="Player Index" />
  710.                                 <Param name="Unit Types - Set of Byte" />
  711.                 </Overload>
  712.                 </KeyWord>
  713.                 <KeyWord name="StatUnitMultipleTypesCount" func="yes">
  714.                         <Overload retVal="State" descr="Returns number of specified unit types for specified player. Types is a set of byte, f.e. [0, 5, 13].">
  715.                                 <Param name="Player Index" />
  716.                                 <Param name="Unit Types - Set of Byte" />
  717.                 </Overload>
  718.                 </KeyWord>
  719.                 <KeyWord name="StatUnitTypeCount" func="yes">
  720.                         <Overload retVal="State" descr="Specified unit type count.">
  721.                                 <Param name="Player Index" />
  722.                                 <Param name="Unit Type" />
  723.                 </Overload>
  724.                 </KeyWord>
  725.                 <KeyWord name="UnitAt" func="yes">
  726.                         <Overload retVal="State" descr="Returns the ID of the unit on the specified tile or -1 if no unit exists there.">
  727.                                 <Param name="X" />
  728.                                 <Param name="Y" />
  729.                 </Overload>
  730.                 </KeyWord>
  731.                 <KeyWord name="UnitCarrying" func="yes">
  732.                         <Overload retVal="State" descr="Returns the ware a serf is carrying, or -1 if the unit is not a serf or is not carrying anything.">
  733.                                 <Param name="Unit ID" />
  734.                 </Overload>
  735.                 </KeyWord>
  736.                 <KeyWord name="UnitDead" func="yes">
  737.                         <Overload retVal="State" descr="Returns true if the unit is dead.">
  738.                                 <Param name="Unit ID" />
  739.                 </Overload>
  740.                 </KeyWord>
  741.                 <KeyWord name="UnitDirection" func="yes">
  742.                         <Overload retVal="State" descr="Returns the direction the specified unit is facing.">
  743.                                 <Param name="Unit ID" />
  744.                 </Overload>
  745.                 </KeyWord>
  746.                 <KeyWord name="UnitHome" func="yes">
  747.                         <Overload retVal="State" descr="Returns the ID of the house which is the home of the specified unit or -1 if the unit does not have a home.">
  748.                                 <Param name="Unit ID" />
  749.                 </Overload>
  750.                 </KeyWord>
  751.                 <KeyWord name="UnitHunger" func="yes">
  752.                         <Overload retVal="State" descr="Returns the hunger level of the specified unit as number of ticks until death or -1 if Unit ID invalid.">
  753.                                 <Param name="Unit ID" />
  754.                 </Overload>
  755.                 </KeyWord>
  756.                 <KeyWord name="UnitIdle" func="yes">
  757.                         <Overload retVal="State" descr="Returns true if specified unit is idle (has no orders/action).">
  758.                                 <Param name="Unit ID" />
  759.                 </Overload>
  760.                 </KeyWord>
  761.                 <KeyWord name="UnitLowHunger" func="yes">
  762.                         <Overload retVal="State" descr="Gives the hunger level when a unit will try to eat in ticks until death.">
  763.                 </Overload>
  764.                 </KeyWord>
  765.                 <KeyWord name="UnitMaxHunger" func="yes">
  766.                         <Overload retVal="State" descr="Gives the maximum hunger level a unit can have in ticks until death.">
  767.                 </Overload>
  768.                 </KeyWord>
  769.                 <KeyWord name="UnitOwner" func="yes">
  770.                         <Overload retVal="State" descr="Returns the owner of the specified unit or -1 if Unit ID invalid.">
  771.                                 <Param name="Unit ID" />
  772.                 </Overload>
  773.                 </KeyWord>
  774.                 <KeyWord name="UnitPositionX" func="yes">
  775.                         <Overload retVal="State" descr="Returns the X coordinate of the specified unit or -1 if Unit ID invalid.">
  776.                                 <Param name="Unit ID" />
  777.                 </Overload>
  778.                 </KeyWord>
  779.                 <KeyWord name="UnitPositionY" func="yes">
  780.                         <Overload retVal="State" descr="Returns the Y coordinate of the specified unit or -1 if Unit ID invalid.">
  781.                                 <Param name="Unit ID" />
  782.                 </Overload>
  783.                 </KeyWord>
  784.                 <KeyWord name="UnitsGroup" func="yes">
  785.                         <Overload retVal="State" descr="Returns the group that the specified unit (warrior) belongs to or -1 if it does not belong to a group.">
  786.                                 <Param name="Unit ID" />
  787.                 </Overload>
  788.                 </KeyWord>
  789.                 <KeyWord name="UnitType" func="yes">
  790.                         <Overload retVal="State" descr="Returns the type of the specified unit.">
  791.                                 <Param name="Unit ID" />
  792.                 </Overload>
  793.                 </KeyWord>
  794.                 <KeyWord name="UnitTypeName" func="yes">
  795.                         <Overload retVal="State" descr="Returns the the translated name of the specified unit type. Note: To ensure multiplayer consistency the name is returned as a number encoded within a markup which is decoded on output, not the actual translated text. Therefore string operations like !LowerCase will not work.">
  796.                                 <Param name="Unit ID" />
  797.                 </Overload>
  798.                 </KeyWord>
  799.                 <KeyWord name="WareTypeName" func="yes">
  800.                         <Overload retVal="State" descr="Returns the the translated name of the specified ware type. Note: To ensure multiplayer consistency the name is returned as a number encoded within a markup which is decoded on output, not the actual translated text. Therefore string operations like !LowerCase will not work.">
  801.                                 <Param name="Ware Type" />
  802.                 </Overload>
  803.                 </KeyWord>
  804.                 <!-- ------- -->
  805.                 <!-- Actions -->
  806.                 <!-- ------- -->
  807.                 <KeyWord name="Actions." />
  808.                 <KeyWord name="AIAutoAttackRange" func="yes">
  809.                         <Overload retVal="Action" descr="Sets AI auto attack range. AI groups will automatically attack if you are closer than this many tiles.">
  810.                                 <Param name="Player Index" />
  811.                                 <Param name="Range - 1..20" />
  812.                 </Overload>
  813.                 </KeyWord>
  814.                 <KeyWord name="AIAutoBuild" func="yes">
  815.                         <Overload retVal="Action" descr="Sets whether the AI should build and manage his own village.">
  816.                                 <Param name="Player Index" />
  817.                                 <Param name="Enabled: Boolean" />
  818.                 </Overload>
  819.                 </KeyWord>
  820.                 <KeyWord name="AIAutoDefence" func="yes">
  821.                         <Overload retVal="Action" descr="Sets whether the AI should position his soldiers automatically.">
  822.                                 <Param name="Player Index" />
  823.                                 <Param name="Enabled: Boolean" />
  824.                 </Overload>
  825.                 </KeyWord>
  826.                 <KeyWord name="AIAutoRepair" func="yes">
  827.                         <Overload retVal="Action" descr="Sets whether the AI should automatically repair damaged buildings.">
  828.                                 <Param name="Player Index" />
  829.                                 <Param name="Enabled: Boolean" />
  830.                 </Overload>
  831.                 </KeyWord>
  832.                 <KeyWord name="AIDefencePositionAdd" func="yes">
  833.                         <Overload retVal="Action" descr="Adds a defence position for the specified AI player. Group Type: 0 Melee, 1 Antihorse, 2 Ranged, 3 Mounted">
  834.                                 <Param name="Player Index" />
  835.                                 <Param name="X" />
  836.                                 <Param name="Y" />
  837.                                 <Param name="Direction" />
  838.                                 <Param name="Group Type" />
  839.                                 <Param name="Defence Radius" />
  840.                                 <Param name="Defence Type" />
  841.                 </Overload>
  842.                 </KeyWord>
  843.                 <KeyWord name="AIDefencePositionRemove" func="yes">
  844.                         <Overload retVal="Action" descr="Removes defence position at X, Y.">
  845.                                 <Param name="Player Index" />
  846.                                 <Param name="X" />
  847.                                 <Param name="Y" />
  848.                 </Overload>
  849.                 </KeyWord>
  850.                 <KeyWord name="AIDefencePositionRemoveAll" func="yes">
  851.                         <Overload retVal="Action" descr="Removes all defence positions for specified AI player.">
  852.                                 <Param name="Player Index" />
  853.                 </Overload>
  854.                 </KeyWord>
  855.                 <KeyWord name="AIDefendAllies" func="yes">
  856.                         <Overload retVal="Action" descr="Sets whether AI should defend units and houses of allies as if they were its own.">
  857.                                 <Param name="Player Index" />
  858.                                 <Param name="Defend: Boolean" />
  859.                 </Overload>
  860.                 </KeyWord>
  861.                 <KeyWord name="AIEquipRate" func="yes">
  862.                         <Overload retVal="Action" descr="Sets the warriors equip rate for AI. (type: 0 - leather, 1 - iron).">
  863.                                 <Param name="Player Index" />
  864.                                 <Param name="Type" />
  865.                                 <Param name="Rate" />
  866.                 </Overload>
  867.                 </KeyWord>
  868.                 <KeyWord name="AIGroupsFormationSet" func="yes">
  869.                         <Overload retVal="Action" descr="Sets the formation the AI uses for defence positions. (Not working in r6720)">
  870.                                 <Param name="Player Index" />
  871.                                 <Param name="Group Type" />
  872.                                 <Param name="Units" />
  873.                                 <Param name="Columns" />
  874.                 </Overload>
  875.                 </KeyWord>
  876.                 <KeyWord name="AISoldiersLimit" func="yes">
  877.                         <Overload retVal="Action" descr="Sets the maximum number of soldiers the AI will train, or -1 for unlimited.">
  878.                                 <Param name="Player Index" />
  879.                                 <Param name="Count" />
  880.                 </Overload>
  881.                 </KeyWord>
  882.                 <KeyWord name="AIRecruitDelay" func="yes">
  883.                         <Overload retVal="Action" descr="Sets the number of ticks before the specified AI will start training recruits.">
  884.                                 <Param name="Player Index" />
  885.                                 <Param name="Delay in Ticks" />
  886.                 </Overload>
  887.                 </KeyWord>
  888.                 <KeyWord name="AIRecruitLimit" func="yes">
  889.                         <Overload retVal="Action" descr="Sets the number of recruits the AI will keep in each barracks.">
  890.                                 <Param name="Player Index" />
  891.                                 <Param name="Recruit Limit" />
  892.                 </Overload>
  893.                 </KeyWord>
  894.                 <KeyWord name="AISerfsPerHouse" func="yes">
  895.                         <Overload retVal="Action" descr="Sets the number of serfs the AI will train per house. Can be a decimal (0.25 for 1 serf per 4 houses).">
  896.                                 <Param name="Player Index" />
  897.                                 <Param name="Value - Float" />
  898.                 </Overload>
  899.                 </KeyWord>
  900.                 <KeyWord name="AIStartPosition" func="yes">
  901.                         <Overload retVal="Action" descr="Sets the AI start position which is used for targeting AI attacks.">
  902.                                 <Param name="Player Index" />
  903.                                 <Param name="X" />
  904.                                 <Param name="Y" />
  905.                 </Overload>
  906.                 </KeyWord>
  907.                 <KeyWord name="AIWorkerLimit" func="yes">
  908.                         <Overload retVal="Action" descr="Sets the maximum number of laborers the AI will train.">
  909.                                 <Param name="Player Index" />
  910.                                 <Param name="Count" />
  911.                 </Overload>
  912.                 </KeyWord>
  913.                 <KeyWord name="CinematicStart" func="yes">
  914.                         <Overload retVal="Action" descr="Puts the player in cinematic mode, blocking user input and allowing the screen to be panned.">
  915.                                 <Param name="Player Index" />
  916.                 </Overload>
  917.                 </KeyWord>
  918.                 <KeyWord name="CinematicEnd" func="yes">
  919.                         <Overload retVal="Action" descr="Exits cinematic mode.">
  920.                                 <Param name="Player Index" />
  921.                 </Overload>
  922.                 </KeyWord>
  923.                 <KeyWord name="CinematicPanTo" func="yes">
  924.                         <Overload retVal="Action" descr="Pans the center of the player's screen to the given location over a set number of ticks. If Duration = 0 then the screen moves instantly.">
  925.                                 <Param name="Player Index" />
  926.                                 <Param name="X" />
  927.                                 <Param name="Y" />
  928.                                 <Param name="Duration" />
  929.                 </Overload>
  930.                 </KeyWord>
  931.                 <KeyWord name="FogCoverAll" func="yes">
  932.                         <Overload retVal="Action" descr="Covers (un-reveals) the entire map in fog of war for player.">
  933.                                 <Param name="Player Index" />
  934.                 </Overload>
  935.                 </KeyWord>
  936.                 <KeyWord name="FogCoverCircle" func="yes">
  937.                         <Overload retVal="Action" descr="Covers (un-reveals) a circle in fog of war for player.">
  938.                                 <Param name="Player Index" />
  939.                                 <Param name="X" />
  940.                                 <Param name="Y" />
  941.                                 <Param name="Radius" />
  942.                 </Overload>
  943.                 </KeyWord>
  944.                 <KeyWord name="FogCoverRect" func="yes">
  945.                         <Overload retVal="Action" descr="Covers a rectangular area in fog of war for player.">
  946.                                 <Param name="Player Index" />
  947.                                 <Param name="From X" />
  948.                                 <Param name="From Y" />
  949.                                 <Param name="To X" />
  950.                                 <Param name="To Y" />
  951.                 </Overload>
  952.                 </KeyWord>
  953.                 <KeyWord name="FogRevealAll" func="yes">
  954.                         <Overload retVal="Action" descr="Reveals the entire map in fog of war for player.">
  955.                                 <Param name="Player Index" />
  956.                 </Overload>
  957.                 </KeyWord>
  958.                 <KeyWord name="FogRevealCircle" func="yes">
  959.                         <Overload retVal="Action" descr="Reveals a circle in fog of war for player.">
  960.                                 <Param name="Player Index" />
  961.                                 <Param name="X" />
  962.                                 <Param name="Y" />
  963.                                 <Param name="Radius" />
  964.                 </Overload>
  965.                 </KeyWord>
  966.                 <KeyWord name="FogRevealRect" func="yes">
  967.                         <Overload retVal="Action" descr="Reveals a rectangular area in fog of war for player.">
  968.                                 <Param name="Player Index" />
  969.                                 <Param name="From X" />
  970.                                 <Param name="From Y" />
  971.                                 <Param name="To X" />
  972.                                 <Param name="To Y" />
  973.                 </Overload>
  974.                 </KeyWord>
  975.                 <KeyWord name="GiveAnimal" func="yes">
  976.                         <Overload retVal="Action" descr="Adds an animal to the game and returns the unit ID or -1 if the animal was not able to be added. UnitID: Integer">
  977.                                 <Param name="Animal Type" />
  978.                                 <Param name="X" />
  979.                                 <Param name="Y" />
  980.                 </Overload>
  981.                 </KeyWord>
  982.                 <KeyWord name="GiveField" func="yes">
  983.                         <Overload retVal="Action" descr="Adds finished field and returns true if field was successfully added. Success: Boolean">
  984.                                 <Param name="Player ID" />
  985.                                 <Param name="X" />
  986.                                 <Param name="Y" />
  987.                 </Overload>
  988.                 </KeyWord>
  989.                 <KeyWord name="GiveGroup" func="yes">
  990.                         <Overload retVal="Action" descr="Give player group of warriors and return the group ID or -1 if the group was not able to be added. GroupID: Integer">
  991.                                 <Param name="Player Index" />
  992.                                 <Param name="Unit Type" />
  993.                                 <Param name="X" />
  994.                                 <Param name="Y" />
  995.                                 <Param name="Face Direction" />
  996.                                 <Param name="Unit Count" />
  997.                                 <Param name="Unit per Row" />
  998.                 </Overload>
  999.                 </KeyWord>
  1000.                 <KeyWord name="GiveHouse" func="yes">
  1001.                         <Overload retVal="Action" descr="Give player a built house and returns the house ID or -1 if the house was not able to be added. HouseID: Integer">
  1002.                                 <Param name="Player Index" />
  1003.                                 <Param name="House Type" />
  1004.                                 <Param name="X" />
  1005.                                 <Param name="Y" />
  1006.                 </Overload>
  1007.                 </KeyWord>
  1008.                 <KeyWord name="GiveHouseSite" func="yes">
  1009.                         <Overload retVal="Action" descr="Give player a digged house area and returns House ID or -1 if house site was not able to be added. If !AddMaterials = True, wood and stone will be added. HouseID: Integer">
  1010.                                 <Param name="Player Index" />
  1011.                                 <Param name="House Type" />
  1012.                                 <Param name="X" />
  1013.                                 <Param name="Y" />
  1014.                                 <Param name="!AddMaterials: Boolean" />
  1015.                 </Overload>
  1016.                 </KeyWord>
  1017.                 <KeyWord name="GiveRoad" func="yes">
  1018.                         <Overload retVal="Action" descr="Adds finished road and returns true if road was successfully added. Success: Boolean">
  1019.                                 <Param name="Player ID" />
  1020.                                 <Param name="X" />
  1021.                                 <Param name="Y" />
  1022.                 </Overload>
  1023.                 </KeyWord>
  1024.                 <KeyWord name="GiveUnit" func="yes">
  1025.                         <Overload retVal="Action" descr="Give player a single citizen and returns the unit ID or -1 if the unit was not able to be added. UnitID: Integer">
  1026.                                 <Param name="Player Index" />
  1027.                                 <Param name="Unit Type" />
  1028.                                 <Param name="X" />
  1029.                                 <Param name="Y" />
  1030.                                 <Param name="Face Direction" />
  1031.                 </Overload>
  1032.                 </KeyWord>
  1033.                 <KeyWord name="GiveWares" func="yes">
  1034.                         <Overload retVal="Action" descr="Adds amount of wares to players 1st Store.">
  1035.                                 <Param name="Player Index" />
  1036.                                 <Param name="Ware Type" />
  1037.                                 <Param name="Count" />
  1038.                 </Overload>
  1039.                 </KeyWord>
  1040.                 <KeyWord name="GiveWeapons" func="yes">
  1041.                         <Overload retVal="Action" descr="Adds amount of weapons to players 1st Barracks.">
  1042.                                 <Param name="Player Index" />
  1043.                                 <Param name="Ware Type" />
  1044.                                 <Param name="Count" />
  1045.                 </Overload>
  1046.                 </KeyWord>
  1047.                 <KeyWord name="GiveWineField" func="yes">
  1048.                         <Overload retVal="Action" descr="Adds finished winefield and returns true if winefield was successfully added. Success: Boolean">
  1049.                                 <Param name="Player ID" />
  1050.                                 <Param name="X" />
  1051.                                 <Param name="Y" />
  1052.                 </Overload>
  1053.                 </KeyWord>
  1054.                 <KeyWord name="GroupBlockOrders" func="yes">
  1055.                         <Overload retVal="Action" descr="Disables (Disable = True) or enables (Disable = False) control over specifed warriors group.">
  1056.                                 <Param name="Group ID" />
  1057.                                 <Param name="Disable: Boolean" />
  1058.                 </Overload>
  1059.                 </KeyWord>
  1060.                 <KeyWord name="GroupDisableHungryMessage" func="yes">
  1061.                         <Overload retVal="Action" descr="Sets whether the specified group will alert the player when they become hungry (true to disable hunger messages, false to enable them).">
  1062.                                 <Param name="Group ID" />
  1063.                                 <Param name="Disable: Boolean" />
  1064.                 </Overload>
  1065.                 </KeyWord>
  1066.                 <KeyWord name="GroupHungerSet" func="yes">
  1067.                         <Overload retVal="Action" descr="Set hunger level for all group members.">
  1068.                                 <Param name="Group ID" />
  1069.                                 <Param name="Hunger Level - Ticks until death" />
  1070.                 </Overload>
  1071.                 </KeyWord>
  1072.                 <KeyWord name="GroupKillAll" func="yes">
  1073.                         <Overload retVal="Action" descr="Kills all members of the specified group.">
  1074.                                 <Param name="Group ID" />
  1075.                                 <Param name="Silent: Boolean" />
  1076.                 </Overload>
  1077.                 </KeyWord>
  1078.                 <KeyWord name="GroupOrderAttackHouse" func="yes">
  1079.                         <Overload retVal="Action" descr="Order the specified group to attack the specified house.">
  1080.                                 <Param name="Group ID" />
  1081.                                 <Param name="House ID" />
  1082.                 </Overload>
  1083.                 </KeyWord>
  1084.                 <KeyWord name="GroupOrderAttackUnit" func="yes">
  1085.                         <Overload retVal="Action" descr="Order the specified group to attack the specified unit.">
  1086.                                 <Param name="Group ID" />
  1087.                                 <Param name="Unit ID" />
  1088.                 </Overload>
  1089.                 </KeyWord>
  1090.                 <KeyWord name="GroupOrderFood" func="yes">
  1091.                         <Overload retVal="Action" descr="Order the specified group to request food.">
  1092.                                 <Param name="Group ID" />
  1093.                 </Overload>
  1094.                 </KeyWord>
  1095.                 <KeyWord name="GroupOrderHalt" func="yes">
  1096.                         <Overload retVal="Action" descr="Order the specified group to halt.">
  1097.                                 <Param name="Group ID" />
  1098.                 </Overload>
  1099.                 </KeyWord>
  1100.                 <KeyWord name="GroupOrderLink" func="yes">
  1101.                         <Overload retVal="Action" descr="Order the first specified group to link to the second specified group.">
  1102.                                 <Param name="Group ID" />
  1103.                                 <Param name="Group ID" />
  1104.                 </Overload>
  1105.                 </KeyWord>
  1106.                 <KeyWord name="GroupOrderSplit" func="yes">
  1107.                         <Overload retVal="Action" descr="Order the specified group to split in half and return the newly create group ID or -1 if splitting failed (e.g. only 1 member). NewGroupID: Integer">
  1108.                                 <Param name="Group ID" />
  1109.                 </Overload>
  1110.                 </KeyWord>
  1111.                 <KeyWord name="GroupOrderSplitUnit" func="yes">
  1112.                         <Overload retVal="Action" descr="Splits specified unit from the group and returns the newly create group ID or -1 if splitting failed (e.g. only 1 member). NewGroupID: Integer">
  1113.                                 <Param name="Group ID" />
  1114.                                 <Param name="Unit ID" />
  1115.                 </Overload>
  1116.                 </KeyWord>
  1117.                 <KeyWord name="GroupOrderStorm" func="yes">
  1118.                         <Overload retVal="Action" descr="Order the specified group to storm attack.">
  1119.                                 <Param name="Group ID" />
  1120.                 </Overload>
  1121.                 </KeyWord>
  1122.                 <KeyWord name="GroupOrderWalk" func="yes">
  1123.                         <Overload retVal="Action" descr="Order the specified group to walk somewhere.">
  1124.                                 <Param name="Group ID" />
  1125.                                 <Param name="X" />
  1126.                                 <Param name="Y" />
  1127.                                 <Param name="Direction" />
  1128.                 </Overload>
  1129.                 </KeyWord>
  1130.                 <KeyWord name="GroupSetFormation" func="yes">
  1131.                         <Overload retVal="Action" descr="Sets the number of columns (units per row) for the specified group.">
  1132.                                 <Param name="Group ID" />
  1133.                                 <Param name="Columns" />
  1134.                 </Overload>
  1135.                 </KeyWord>
  1136.                 <KeyWord name="HouseAddBuildingMaterials" func="yes">
  1137.                         <Overload retVal="Action" descr="Add building materials to the specified WIP house area.">
  1138.                                 <Param name="House ID" />
  1139.                 </Overload>
  1140.                 </KeyWord>
  1141.                 <KeyWord name="HouseAddBuildingProgress" func="yes">
  1142.                         <Overload retVal="Action" descr="Add 5 points of building progress to the specified WIP house area.">
  1143.                                 <Param name="House ID" />
  1144.                 </Overload>
  1145.                 </KeyWord>
  1146.                 <KeyWord name="HouseAddDamage" func="yes">
  1147.                         <Overload retVal="Action" descr="Add damage to the specified house.">
  1148.                                 <Param name="House ID" />
  1149.                                 <Param name="Damage Amount" />
  1150.                 </Overload>
  1151.                 </KeyWord>
  1152.                 <KeyWord name="HouseAddRepair" func="yes">
  1153.                         <Overload retVal="Action" descr="Reduces damage to the specified house.">
  1154.                                 <Param name="House ID" />
  1155.                                 <Param name="Repair Amount" />
  1156.                 </Overload>
  1157.                 </KeyWord>
  1158.                 <KeyWord name="HouseAddWaresTo" func="yes">
  1159.                         <Overload retVal="Action" descr="Add wares to the specified house.">
  1160.                                 <Param name="House ID" />
  1161.                                 <Param name="Ware Type" />
  1162.                                 <Param name="Count" />
  1163.                 </Overload>
  1164.                 </KeyWord>
  1165.                 <KeyWord name="HouseAllow" func="yes">
  1166.                         <Overload retVal="Action" descr="Sets whether the player is allowed to build the specified house. Note: The house must still be unlocked normally (e.g. sawmill for farm), use !HouseUnlock to override that.">
  1167.                                 <Param name="House ID" />
  1168.                                 <Param name="House Type" />
  1169.                                 <Param name="Allowed: Boolean" />
  1170.                 </Overload>
  1171.                 </KeyWord>
  1172.                 <KeyWord name="HouseBarracksEquip" func="yes">
  1173.                         <Overload retVal="Action" descr="Equips the specified unit from the specified barracks. Returns the number of units successfully equipped. Succeeded: Integer">
  1174.                                 <Param name="House ID" />
  1175.                                 <Param name="Unit Type" />
  1176.                                 <Param name="Count" />
  1177.                 </Overload>
  1178.                 </KeyWord>
  1179.                 <KeyWord name="HouseBarracksGiveRecruit" func="yes">
  1180.                         <Overload retVal="Action" descr="Adds a recruit inside the specified barracks.">
  1181.                                 <Param name="House ID" />
  1182.                 </Overload>
  1183.                 </KeyWord>
  1184.                 <KeyWord name="HouseDeliveryBlock" func="yes">
  1185.                         <Overload retVal="Action" descr="Sets delivery blocking for the specified house.">
  1186.                                 <Param name="House ID" />
  1187.                                 <Param name="Blocked: Boolean" />
  1188.                 </Overload>
  1189.                 </KeyWord>
  1190.                 <KeyWord name="HouseDestroy" func="yes">
  1191.                         <Overload retVal="Action" descr="Destroys the specified house. Silent means the house will not leave rubble or play destroy sound.">
  1192.                                 <Param name="House ID" />
  1193.                                 <Param name="Silent: Boolean" />
  1194.                 </Overload>
  1195.                 </KeyWord>
  1196.                 <KeyWord name="HouseDisableUnoccupiedMessage" func="yes">
  1197.                         <Overload retVal="Action" descr="Sets whether the specified house displays unoccupied messages to the player.">
  1198.                                 <Param name="House ID" />
  1199.                                 <Param name="Disabled: Boolean" />
  1200.                 </Overload>
  1201.                 </KeyWord>
  1202.                 <KeyWord name="HouseRepairEnable" func="yes">
  1203.                         <Overload retVal="Action" descr="Enables house repair for the specified house.">
  1204.                                 <Param name="House ID" />
  1205.                                 <Param name="!EnableRepair: Boolean" />
  1206.                 </Overload>
  1207.                 </KeyWord>
  1208.                 <KeyWord name="HouseSchoolQueueAdd" func="yes">
  1209.                         <Overload retVal="Action" descr="Adds the specified unit to the specified school's queue. Returns the number of units successfully added to the queue. Succeeded: Integer">
  1210.                                 <Param name="House ID" />
  1211.                                 <Param name="Unit Type" />
  1212.                                 <Param name="Count" />
  1213.                 </Overload>
  1214.                 </KeyWord>
  1215.                 <KeyWord name="HouseSchoolQueueRemove" func="yes">
  1216.                         <Overload retVal="Action" descr="Removes the unit from the specified slot of the school queue. Slot 0 is the unit currently training, slots 1..5 are the queue. Succeeded: Integer">
  1217.                                 <Param name="House ID" />
  1218.                                 <Param name="Slot" />
  1219.                 </Overload>
  1220.                 </KeyWord>
  1221.                 <KeyWord name="HouseTakeWaresFrom" func="yes">
  1222.                         <Overload retVal="Action" descr="Remove wares from the specified house. If a serf was on the way to pick up the ware, the serf will abandon his task.">
  1223.                                 <Param name="House ID" />
  1224.                                 <Param name="Ware Type" />
  1225.                                 <Param name="Count" />
  1226.                 </Overload>
  1227.                 </KeyWord>
  1228.                 <KeyWord name="HouseUnlock" func="yes">
  1229.                         <Overload retVal="Action" descr="Allows player to build the specified house even if they don't have the house built that normally unlocks it (e.g. sawmill for farm). Note: Does not override blocked houses, use !HouseAllow for that.">
  1230.                                 <Param name="Player Index" />
  1231.                                 <Param name="House Type" />
  1232.                 </Overload>
  1233.                 </KeyWord>
  1234.                 <KeyWord name="HouseWareBlock" func="yes">
  1235.                         <Overload retVal="Action" descr="Blocks a specific ware in a storehouse or barracks.">
  1236.                                 <Param name="House ID" />
  1237.                                 <Param name="Ware Type" />
  1238.                                 <Param name="Blocked: Boolean" />
  1239.                 </Overload>
  1240.                 </KeyWord>
  1241.                 <KeyWord name="HouseWoodcutterChopOnly" func="yes">
  1242.                         <Overload retVal="Action" descr="Sets whether a woodcutter's hut is on chop-only mode.">
  1243.                                 <Param name="House ID" />
  1244.                                 <Param name="!ChopOnly: Boolean" />
  1245.                 </Overload>
  1246.                 </KeyWord>
  1247.                 <KeyWord name="HouseWeaponsOrderSet" func="yes">
  1248.                         <Overload retVal="Action" descr="Sets the amount of the specified weapon ordered to be produced in the specified house.">
  1249.                                 <Param name="House ID" />
  1250.                                 <Param name="Ware Type" />
  1251.                                 <Param name="Amount" />
  1252.                 </Overload>
  1253.                 </KeyWord>
  1254.                 <KeyWord name="Log" func="yes">
  1255.                         <Overload retVal="Action" descr="Writes a line of text to the game log file. Useful for debugging. Note that many calls to this procedure will have a noticeable performance impact, as well as creating a large log file, so it is recommended you don't use it outside of debugging.">
  1256.                                 <Param name="Text: !AnsiString" />
  1257.                 </Overload>
  1258.                 </KeyWord>
  1259.                 <KeyWord name="MapTileHeightSet" func="yes">
  1260.                         <Overload retVal="Action" descr="Sets the height of the terrain at the top left corner (vertex) of the tile at the specified XY coordinates. Returns true if the change succeeded or false if it failed. The change will fail if it would cause a unit to become stuck or a house to be damaged. Boolean">
  1261.                                 <Param name="X" />
  1262.                                 <Param name="Y" />
  1263.                                 <Param name="Height - 0..100" />
  1264.                 </Overload>
  1265.                 </KeyWord>
  1266.                 <KeyWord name="MapTileObjectSet" func="yes">
  1267.                         <Overload retVal="Action" descr="Sets the terrain object on the tile at the specified XY coordinates. Object IDs can be seen in the map editor on the objects tab. Object 61 is 'block walking'. To set no object, use object type 255. Returns true if the change succeeded or false if it failed. The change will fail if it would cause a unit to become stuck or a house/field to be damaged. Boolean">
  1268.                                 <Param name="X" />
  1269.                                 <Param name="Y" />
  1270.                                 <Param name="Object Type - 0..255" />
  1271.                 </Overload>
  1272.                 </KeyWord>
  1273.                 <KeyWord name="MapTileSet" func="yes">
  1274.                         <Overload retVal="Action" descr="Sets the tile type and rotation at the specified XY coordinates. Tile IDs can be seen by hovering over the tiles on the terrain tiles tab in the map editor. Returns true if the change succeeded or false if it failed. The change will fail if it would cause a unit to become stuck or a house/field to be damaged. Boolean">
  1275.                                 <Param name="X" />
  1276.                                 <Param name="Y" />
  1277.                                 <Param name="Object Type - 0..255" />
  1278.                                 <Param name="Tile Rotation - 0..3" />
  1279.                 </Overload>
  1280.                 </KeyWord>
  1281.                 <KeyWord name="MarketSetTrade" func="yes">
  1282.                         <Overload retVal="Action" descr="Sets the trade in the specified market.">
  1283.                                 <Param name="House ID" />
  1284.                                 <Param name="From Ware Type" />
  1285.                                 <Param name="To Ware Type" />
  1286.                                 <Param name="Amount" />
  1287.                 </Overload>
  1288.                 </KeyWord>
  1289.                 <KeyWord name="OverlayTextSet" func="yes">
  1290.                         <Overload retVal="Action" descr="Sets text overlaid on top left of screen. If the player index is -1 it will be set for all players.">
  1291.                                 <Param name="Player Index" />
  1292.                                 <Param name="Text: !AnsiString" />
  1293.                 </Overload>
  1294.                 </KeyWord>
  1295.                 <KeyWord name="OverlayTextSetFormatted" func="yes">
  1296.                         <Overload retVal="Action" descr="Sets text overlaid on top left of screen with formatted arguments (same as Format function). If the player index is -1 it will be set for all players.">
  1297.                                 <Param name="Player Index" />
  1298.                                 <Param name="Text: !AnsiString" />
  1299.                                 <Param name="Array of Arguments" />
  1300.                 </Overload>
  1301.                 </KeyWord>
  1302.                 <KeyWord name="OverlayTextAppend" func="yes">
  1303.                         <Overload retVal="Action" descr="Appends to text overlaid on top left of screen. If the player index is -1 it will be appended for all players.">
  1304.                                 <Param name="Player Index" />
  1305.                                 <Param name="Text: !AnsiString" />
  1306.                 </Overload>
  1307.                 </KeyWord>
  1308.                 <KeyWord name="PlanAddField" func="yes">
  1309.                         <Overload retVal="Action" descr="Adds a corn field plan. Returns true if the plan was successfully added or false if it failed (e.g. tile blocked). Success: Boolean">
  1310.                                 <Param name="Player Index" />
  1311.                                 <Param name="X" />
  1312.                                 <Param name="Y" />
  1313.                 </Overload>
  1314.                 </KeyWord>
  1315.                 <KeyWord name="PlanAddHouse" func="yes">
  1316.                         <Overload retVal="Action" descr="Adds a house plan. Returns true if the plan was successfully added or false if it failed (e.g. location blocked). Success: Boolean">
  1317.                                 <Param name="Player Index" />
  1318.                                 <Param name="House Type" />
  1319.                                 <Param name="X" />
  1320.                                 <Param name="Y" />
  1321.                 </Overload>
  1322.                 </KeyWord>
  1323.                 <KeyWord name="PlanAddRoad" func="yes">
  1324.                         <Overload retVal="Action" descr="Adds a road plan. Returns true if the plan was successfully added or false if it failed (e.g. tile blocked). Success: Boolean">
  1325.                                 <Param name="Player Index" />
  1326.                                 <Param name="X" />
  1327.                                 <Param name="Y" />
  1328.                 </Overload>
  1329.                 </KeyWord>
  1330.                 <KeyWord name="PlanAddWinefield" func="yes">
  1331.                         <Overload retVal="Action" descr="Adds a wine field plan. Returns true if the plan was successfully added or false if it failed (e.g. tile blocked). Success: Boolean">
  1332.                                 <Param name="Player Index" />
  1333.                                 <Param name="X" />
  1334.                                 <Param name="Y" />
  1335.                 </Overload>
  1336.                 </KeyWord>
  1337.                 <KeyWord name="PlanConnectRoad" func="yes">
  1338.                         <Overload retVal="Action" descr="Connects road plans between two points like AI builder and returns True if road plan was successfully added. If CompletedRoad = True, road will be added instead of plans. Success: Boolean">
  1339.                                 <Param name="Player Index" />
  1340.                                 <Param name="X1" />
  1341.                                 <Param name="Y1" />
  1342.                                 <Param name="X2" />
  1343.                                 <Param name="Y2" />
  1344.                                 <Param name="Completed Road: Boolean" />
  1345.                 </Overload>
  1346.                 </KeyWord>
  1347.                 <KeyWord name="PlanRemove" func="yes">
  1348.                         <Overload retVal="Action" descr="Removes house, road or field plans from the specified tile for the specified player. Success: Boolean">
  1349.                                 <Param name="Player Index" />
  1350.                                 <Param name="X" />
  1351.                                 <Param name="Y" />
  1352.                 </Overload>
  1353.                 </KeyWord>
  1354.                 <KeyWord name="PlayerAddDefaultGoals" func="yes">
  1355.                         <Overload retVal="Action" descr="Add default goals/lost goals for the specified player. If the parameter buildings is true the goals will be important buildings. Otherwise it will be troops.">
  1356.                                 <Param name="Player Index" />
  1357.                                 <Param name="Buildings: Boolean" />
  1358.                 </Overload>
  1359.                 </KeyWord>
  1360.                 <KeyWord name="PlayerAllianceChange" func="yes">
  1361.                         <Overload retVal="Action" descr="Change whether player1 is allied to player2. If Compliment is true, then it is set both ways (so also whether player2 is allied to player1).">
  1362.                                 <Param name="Player1 Index" />
  1363.                                 <Param name="Player2 Index" />
  1364.                                 <Param name="Compliment: Boolean" />
  1365.                                 <Param name="Allied: Boolean" />
  1366.                 </Overload>
  1367.                 </KeyWord>
  1368.                 <KeyWord name="PlayerDefeat" func="yes">
  1369.                         <Overload retVal="Action" descr="Proclaims player defeated.">
  1370.                                 <Param name="Player Index" />
  1371.                 </Overload>
  1372.                 </KeyWord>
  1373.                 <KeyWord name="PlayerShareFog" func="yes">
  1374.                         <Overload retVal="Action" descr="Sets whether player A shares his vision with player B. Sharing can still only happen between allied players, but this command lets you disable allies from sharing.">
  1375.                                 <Param name="Player A" />
  1376.                                 <Param name="Player B" />
  1377.                                 <Param name="Share: Boolean" />
  1378.                 </Overload>
  1379.                 </KeyWord>
  1380.                 <KeyWord name="PlayerWareDistribution" func="yes">
  1381.                         <Overload retVal="Action" descr="Sets ware distribution for the specified resource, house and player.">
  1382.                                 <Param name="Player Index" />
  1383.                                 <Param name="Recource Type" />
  1384.                                 <Param name="House Type" />
  1385.                                 <Param name="Distribution Amount - 0..5" />
  1386.                 </Overload>
  1387.                 </KeyWord>
  1388.                 <KeyWord name="PlayerWin" func="yes">
  1389.                         <Overload retVal="Action" descr="Set specified player(s) victorious, and all team members of those player(s) if the 2nd parameter !TeamVictory is set to true. All players who were not set to victorious are set to defeated.">
  1390.                                 <Param name="Array of Player Index" />
  1391.                                 <Param name="!TeamVictory: Boolean" />
  1392.                 </Overload>
  1393.                 </KeyWord>
  1394.                 <KeyWord name="PlayWAV" func="yes">
  1395.                         <Overload retVal="Action" descr="Plays audio file. If the player index is -1 the sound will be played to all players. Mono or stereo WAV files are supported. WAV file goes in mission folder named: Mission Name.filename.wav.">
  1396.                                 <Param name="Player Index" />
  1397.                                 <Param name="Filename" />
  1398.                                 <Param name="Volume - 0.0 to 1.0" />
  1399.                 </Overload>
  1400.                 </KeyWord>
  1401.                 <KeyWord name="PlayWAVFadeMusic" func="yes">
  1402.                         <Overload retVal="Action" descr="Same as PlayWAV except music will fade then mute while the WAV is playing, then fade back in afterwards. You should leave a small gap at the start of your WAV file to give the music time to fade.">
  1403.                                 <Param name="Player Index" />
  1404.                                 <Param name="Filename" />
  1405.                                 <Param name="Volume - 0.0 to 1.0" />
  1406.                 </Overload>
  1407.                 </KeyWord>
  1408.                 <KeyWord name="PlayWAVAtLocation" func="yes">
  1409.                         <Overload retVal="Action" descr="Plays audio file at a location on the map. If the player index is -1 the sound will be played to all players. Radius specifies approximately the distance at which the sound can no longer be heard (normal game sounds use radius 32). Only mono WAV files are supported. WAV file goes in mission folder named: Mission Name.filename.wav. Will not play if the location is not revealed to the player. Higher volume range is allowed than PlayWAV as positional sounds are quieter.">
  1410.                                 <Param name="Player Index" />
  1411.                                 <Param name="Filename" />
  1412.                                 <Param name="Volume - 0.0 to 4.0" />
  1413.                                 <Param name="Radius - min. 28" />
  1414.                                 <Param name="X" />
  1415.                                 <Param name="Y" />
  1416.                 </Overload>
  1417.                 </KeyWord>
  1418.                 <KeyWord name="PlayWAVLooped" func="yes">
  1419.                         <Overload retVal="Action" descr="Plays looped audio file. If the player index is -1 the sound will be played to all players. Mono or stereo WAV files are supported. WAV file goes in mission folder named: Mission Name.filename.wav. The sound will continue to loop if the game is paused and will restart automatically when the game is loaded. Returns the !LoopIndex of the sound which can be used to stop it with Actions.StopLoopedWAV. !LoopIndex: Integer">
  1420.                                 <Param name="Player Index" />
  1421.                                 <Param name="Filename" />
  1422.                                 <Param name="Volume - 0.0 to 1.0" />
  1423.                 </Overload>
  1424.                 </KeyWord>
  1425.                 <KeyWord name="PlayWAVAtLocationLooped" func="yes">
  1426.                         <Overload retVal="Action" descr="Plays looped audio file at a location on the map. If the player index is -1 the sound will be played to all players. Radius specifies approximately the distance at which the sound can no longer be heard (normal game sounds use radius 32). Only mono WAV files are supported. WAV file goes in mission folder named: Mission Name.filename.wav. Will not play if the location is not revealed to the player (will start playing automatically when it is revealed). Higher volume range is allowed than PlayWAV as positional sounds are quieter. The sound will continue to loop if the game is paused and will restart automatically when the game is loaded. Returns the !LoopIndex of the sound which can be used to stop it with Actions.StopLoopedWAV. !LoopIndex: Integer">
  1427.                                 <Param name="Player Index" />
  1428.                                 <Param name="Filename" />
  1429.                                 <Param name="Volume - 0.0 to 4.0" />
  1430.                                 <Param name="Radius - min. 28" />
  1431.                                 <Param name="X" />
  1432.                                 <Param name="Y" />
  1433.                 </Overload>
  1434.                 </KeyWord>
  1435.                 <KeyWord name="RemoveRoad" func="yes">
  1436.                         <Overload retVal="Action" descr="Removes road.">
  1437.                                 <Param name="X" />
  1438.                                 <Param name="Y" />
  1439.                 </Overload>
  1440.                 </KeyWord>
  1441.                 <KeyWord name="SetTradeAllowed" func="yes">
  1442.                         <Overload retVal="Action" descr="Sets whether the player is allowed to trade the specified resource.">
  1443.                                 <Param name="Player Index" />
  1444.                                 <Param name="Ware Type" />
  1445.                                 <Param name="Allowed: Boolean" />
  1446.                 </Overload>
  1447.                 </KeyWord>
  1448.                 <KeyWord name="ShowMsg" func="yes">
  1449.                         <Overload retVal="Action" descr="Displays a message to a player. If the player index is -1 the message will be shown to all players.">
  1450.                                 <Param name="Player Index" />
  1451.                                 <Param name="Text: !AnsiString" />
  1452.                 </Overload>
  1453.                 </KeyWord>
  1454.                 <KeyWord name="ShowMsgGoto" func="yes">
  1455.                         <Overload retVal="Action" descr="Displays a message to a player with a goto button that takes the player to the specified location. If the player index is -1 the message will be shown to all players.">
  1456.                                 <Param name="Player Index" />
  1457.                                 <Param name="X" />
  1458.                                 <Param name="Y" />
  1459.                                 <Param name="Text: !AnsiString" />
  1460.                 </Overload>
  1461.                 </KeyWord>
  1462.                 <KeyWord name="ShowMsgFormatted" func="yes">
  1463.                         <Overload retVal="Action" descr="Displays a message to a player with formatted arguments (same as Format function). If the player index is -1 the message will be shown to all players.">
  1464.                                 <Param name="Player Index" />
  1465.                                 <Param name="Text: !AnsiString" />
  1466.                                 <Param name="Array of Arguments" />
  1467.                 </Overload>
  1468.                 </KeyWord>
  1469.                 <KeyWord name="StopLoopedWAV" func="yes">
  1470.                         <Overload retVal="Action" descr="Stops playing a looped sound that was previously started with either Actions.PlayWAVLooped or Actions.PlayWAVAtLocationLooped. !LoopIndex is the value that was returned by either of those functions when the looped sound was started.">
  1471.                                 <Param name="!LoopIndex" />
  1472.                 </Overload>
  1473.                 </KeyWord>
  1474.                 <KeyWord name="UnitBlock" func="yes">
  1475.                         <Overload retVal="Action" descr="Sets whether the specified player can train/equip the specified unit type.">
  1476.                                 <Param name="Player Index" />
  1477.                                 <Param name="Unit Type" />
  1478.                                 <Param name="Block: Boolean" />
  1479.                 </Overload>
  1480.                 </KeyWord>
  1481.                 <KeyWord name="UnitDirectionSet" func="yes">
  1482.                         <Overload retVal="Action" descr="Makes the specified unit face a certain direction. Note: Only works on idle units so as not to interfere with game logic and cause crashes. Returns true on success or false on failure. Success: Boolean">
  1483.                                 <Param name="Unit ID" />
  1484.                                 <Param name="Direction" />
  1485.                 </Overload>
  1486.                 </KeyWord>
  1487.                 <KeyWord name="UnitHungerSet" func="yes">
  1488.                         <Overload retVal="Action" descr="Sets the hunger level of the specified unit in ticks until death.">
  1489.                                 <Param name="Unit ID" />
  1490.                                 <Param name="Hunger level - Ticks until Death" />
  1491.                 </Overload>
  1492.                 </KeyWord>
  1493.                 <KeyWord name="UnitKill" func="yes">
  1494.                         <Overload retVal="Action" descr="Kills the specified unit. Silent means the death animation (ghost) and sound won't play.">
  1495.                                 <Param name="Unit ID" />
  1496.                                 <Param name="Silent: Boolean" />
  1497.                 </Overload>
  1498.                 </KeyWord>
  1499.                 <KeyWord name="UnitOrderWalk" func="yes">
  1500.                         <Overload retVal="Action" descr="Order the specified unit to walk somewhere. Note: Only works on idle units so as not to interfere with game logic and cause crashes. Returns true on success or false on failure. Success: Boolean">
  1501.                                 <Param name="Unit ID" />
  1502.                                 <Param name="X" />
  1503.                                 <Param name="Y" />
  1504.                 </Overload>
  1505.                 </KeyWord>     
  1506.         </AutoComplete>
  1507. </NotepadPlus>

Replies to Untitled rss

Title Name Language When
Re: Untitled Gracious Tern xml 1 Year ago.
Re: Untitled Unique Meerkat xml 1 Year ago.
Re: Untitled Funky Crocodile xml 1 Year ago.
Re: Untitled Cream Cassowary xml 1 Year ago.
Re: Untitled Voluminous Water Vole xml 1 Year ago.
Re: Untitled Insensitive Dove xml 1 Year ago.