TYPES | FUNCTIONS | VARIABLES

Functions in common.ai

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

A

Line	Constant	Type	Name	Parameters	Return Type
74		native	AddAssault	integer qty, integer id	boolean
75		native	AddDefenders	integer qty, integer id	boolean
101		native	AddGuardPost	integer id, real x, real y	nothing
2095		function	AddSiege		nothing
1407		function	AddSleepSeconds	integer seconds	nothing
2058		function	AnyPlayerAttack		nothing
87		native	AttackMoveKill	unit target	nothing
2021		function	AttackMoveKillA	unit target	nothing
88		native	AttackMoveXY	integer x, integer y	nothing
1712		function	AttackMoveXYA	integer x, integer y	nothing
2510		function	AwaitMeleeHeroes		nothing

BACK TO TOP

B

Line	Constant	Type	Name	Parameters	Return Type
1174		function	BasicExpansion	boolean build_it, integer unitid	nothing
2298		function	BuildAttackers		nothing
2322		function	BuildDefenders		nothing
1068		function	BuildFactory	integer unitid	nothing
1387		function	BuildLoop		nothing

BACK TO TOP

C

Line	Constant	Type	Name	Parameters	Return Type
2398		function	CampaignAI	integer farms, code heroes	nothing
1541		function	CampaignAttacker	integer level, integer qty, integer unitid	nothing
1548		function	CampaignAttackerEx	integer easy, integer med, integer hard, integer unitid	nothing
2387		function	CampaignBasics		nothing
2340		function	CampaignBasicsA		nothing
1519		function	CampaignDefender	integer level, integer qty, integer unitid	nothing
1530		function	CampaignDefenderEx	integer easy, integer med, integer hard, integer unitid	nothing
122		native	CaptainAtGoal		boolean
110		native	CaptainAttack	real x, real y	nothing
113		native	CaptainGoHome		nothing
117		native	CaptainGroupSize		integer
92		native	CaptainInCombat	boolean attack_captain	boolean
116		native	CaptainIsEmpty		boolean
115		native	CaptainIsFull		boolean
114		native	CaptainIsHome		boolean
118		native	CaptainReadiness		integer
120		native	CaptainReadinessHP		integer
121		native	CaptainReadinessMa		integer
119		native	CaptainRetreating		boolean
112		native	CaptainVsPlayer	player id	nothing
111		native	CaptainVsUnits	player id	nothing
109		native	ClearCaptainTargets		nothing
95		native	ClearHarvestAI		nothing
135		native	CommandsWaiting		integer
1984		function	CommonSleepUntilTargetDead	unit target, boolean reform	nothing
1779		function	CommonSuicideOnPlayer	boolean standard, boolean bldgs, integer seconds, player p, integer x, integer y	nothing
1433		function	Conversions	integer desire, integer unitid	nothing
1426		function	ConvertNeeds	integer unitid	nothing
50		native	ConvertUnits	integer qty, integer id	boolean
104		native	CreateCaptains		nothing
2050		function	CreepAttackEx		nothing
123		native	CreepsOnMap		boolean

BACK TO TOP

D

Line	Constant	Type	Name	Parameters	Return Type
5		native	DebugFI	string str, integer val	nothing
4		native	DebugS	string str	nothing
6		native	DebugUnitID	string str, integer val	nothing
132		native	DisablePathing		nothing
7		native	DisplayText	integer p, string str	nothing
8		native	DisplayTextI	integer p, string str, integer val	nothing
9		native	DisplayTextII	integer p, string str, integer v1, integer v2	nothing
10		native	DisplayTextIII	integer p, string str, integer v1, integer v2, integer v3	nothing
11		native	DoAiScriptDebug		boolean
906		function	DoCampaignFarms	boolean state	nothing

BACK TO TOP

E

Line	Constant	Type	Name	Parameters	Return Type
2077		function	ExpansionAttack		nothing

BACK TO TOP

F

Line	Constant	Type	Name	Parameters	Return Type
102		native	FillGuardPosts		nothing
2293		function	FoodAvail	integer base	integer
2283		function	FoodCap		integer
1193		function	FoodPool	integer food, boolean weak, integer id1, integer use1, boolean strong, integer id2, integer use2	nothing
2288		function	FoodSpace		integer
2278		function	FoodUsed		integer
1974		function	ForeverSuicideOnPlayer	integer seconds, player p	nothing
1559		function	FormGroup	integer seconds, boolean testReady	nothing

BACK TO TOP

G

Line	Constant	Type	Name	Parameters	Return Type
13		native	GetAiPlayer		integer
39		native	GetAllianceTarget		unit
2107		function	GetAllyCount	player whichPlayer	integer
36		native	GetBuilding	player p	unit
77		native	GetCreepCamp	integer min, integer max, boolean flyers_ok	unit
81		native	GetEnemyBase		unit
83		native	GetEnemyExpansion		unit
37		native	GetEnemyPower		integer
82		native	GetExpansionFoe		unit
98		native	GetExpansionPeon		unit
84		native	GetExpansionX		integer
85		native	GetExpansionY		integer
921		function	GetGold		integer
26		native	GetGoldOwned		integer
14		native	GetHeroId		integer
15		native	GetHeroLevelAI		integer
136		native	GetLastCommand		integer
137		native	GetLastData		integer
916		function	GetMajorCreep		unit
35		native	GetMegaTarget		unit
25		native	GetMinesOwned		integer
911		function	GetMinorCreep		unit
34		native	GetNextExpansion		integer
18		native	GetPlayerUnitTypeCount	player p, integer unitid	integer
20		native	GetTownUnitCount	integer id, integer tn, boolean dn	integer
23		native	GetUnitBuildTime	integer unitid	integer
17		native	GetUnitCount	integer unitid	integer
19		native	GetUnitCountDone	integer unitid	integer
1089		function	GetUnitCountEx	integer unitid, boolean only_done, integer townid	integer
21		native	GetUnitGoldCost	integer unitid	integer
22		native	GetUnitWoodCost	integer unitid	integer
32		native	GetUpgradeGoldCost	integer id	integer
31		native	GetUpgradeLevel	integer id	integer
33		native	GetUpgradeWoodCost	integer id	integer
926		function	GetWood		integer
2271		function	GetZeppelin		nothing
69		native	GroupTimedLife	boolean allow	nothing
1082		function	GuardSecondary	integer townid, integer qty, integer unitid	nothing

BACK TO TOP

H

Line	Constant	Type	Name	Parameters	Return Type
1077		function	HallsCompleted	integer unitid	boolean
96		native	HarvestGold	integer town, integer peons	nothing
97		native	HarvestWood	integer town, integer peons	nothing

BACK TO TOP

I

Line	Constant	Type	Name	Parameters	Return Type
130		native	IgnoredUnits	integer unitid	integer
772		function	InitAI		nothing
73		native	InitAssault		nothing
936		function	InitAssaultGroup		nothing
931		function	InitBuildArray		nothing
941		function	InitDefenseGroup		nothing
946		function	InitMeleeGroup		nothing
1464		function	Interleave3	integer e1, integer m1, integer h1, integer u1, integer e2, integer m2, integer h2, integer u2, integer e3, integer m3, integer h3, integer u3	nothing
93		native	IsTowered	unit target	boolean

BACK TO TOP

J

BACK TO TOP

K

BACK TO TOP

L

Line	Constant	Type	Name	Parameters	Return Type
89		native	LoadZepWave	integer x, integer y	nothing

BACK TO TOP

M

Line	Constant	Type	Name	Parameters	Return Type
2042		function	MajorCreepAttack		nothing
819		function	Max	integer A, integer B	integer
139		native	MeleeDifficulty		integer
1204		function	MeleeTownHall	integer townid, integer unitid	nothing
49		native	MergeUnits	integer qty, integer a, integer b, integer make	boolean
811		function	Min	integer A, integer B	integer
2034		function	MinorCreepAttack		nothing

BACK TO TOP

N

BACK TO TOP

O

Line	Constant	Type	Name	Parameters	Return Type
1344		function	OneBuildLoop		nothing

BACK TO TOP

P

Line	Constant	Type	Name	Parameters	Return Type
2523		function	PickMeleeHero	race raceid	integer
739		function	PlayerEx	integer slot	player
1420		function	PlayGame		nothing
138		native	PopLastCommand		nothing
953		function	PrepFullSuicide		nothing
1656		function	PrepSuicideOnPlayer	integer seconds	boolean
1629		function	PrepTime		integer
47		native	PurchaseZeppelin		nothing

BACK TO TOP

Q

BACK TO TOP

R

Line	Constant	Type	Name	Parameters	Return Type
2015		function	ReformUntilTargetDead	unit target	nothing
70		native	RemoveInjuries		nothing
71		native	RemoveSiege		nothing
106		native	ResetCaptainLocs		nothing
103		native	ReturnGuardPosts		nothing

BACK TO TOP

S

Line	Constant	Type	Name	Parameters	Return Type
1013		function	SecondaryTown	integer town, integer qty, integer unitid	nothing
1018		function	SecTown	integer town, integer qty, integer unitid	nothing
38		native	SetAllianceTarget	unit id	nothing
133		native	SetAmphibious		nothing
1451		function	SetAssaultGroup	integer qty, integer max, integer unitid	nothing
977		function	SetBuildAll	integer t, integer qty, integer unitid, integer town	nothing
1041		function	SetBuildExpa	integer qty, integer unitid	nothing
993		function	SetBuildNext	integer qty, integer unitid	nothing
988		function	SetBuildUnit	integer qty, integer unitid	nothing
1002		function	SetBuildUnitEx	integer easy, integer med, integer hard, integer unitid	nothing
1023		function	SetBuildUpgr	integer qty, integer unitid	nothing
1030		function	SetBuildUpgrEx	integer easy, integer med, integer hard, integer unitid	nothing
52		native	SetCampaignAI		nothing
66		native	SetCaptainChanges	boolean allow	nothing
105		native	SetCaptainHome	integer which, real x, real y	nothing
57		native	SetDefendPlayer	boolean state	nothing
43		native	SetExpansion	unit peon, integer id	boolean
901		function	SetFormGroupTimeouts	boolean state	nothing
887		function	SetGoldPeons	integer count	nothing
64		native	SetGroupsFlee	boolean state	nothing
892		function	SetHarvestLumber	boolean harvest	nothing
59		native	SetHeroesBuyItems	boolean state	nothing
58		native	SetHeroesFlee	boolean state	nothing
62		native	SetHeroesTakeItems	boolean state	nothing
45		native	SetHeroLevels	code func	nothing
61		native	SetIgnoreInjured	boolean state	nothing
1402		function	SetInitialWave	integer seconds	nothing
53		native	SetMeleeAI		nothing
1510		function	SetMeleeGroup	integer unitid	nothing
46		native	SetNewHeroes	boolean state	nothing
55		native	SetPeonsRepair	boolean state	nothing
41		native	SetProduce	integer qty, integer id, integer town	boolean
56		native	SetRandomPaths	boolean state	nothing
68		native	SetReplacementCount	integer qty	nothing
961		function	SetReplacements	integer easy, integer med, integer hard	nothing
2474		function	SetSkillArray	integer index, integer id	nothing
65		native	SetSlowChopping	boolean state	nothing
67		native	SetSmartArtillery	boolean state	nothing
86		native	SetStagePoint	real x, real y	nothing
54		native	SetTargetHeroes	boolean state	nothing
63		native	SetUnitsFlee	boolean state	nothing
44		native	SetUpgrade	integer id	boolean
60		native	SetWatchMegaTargets	boolean state	nothing
882		function	SetWoodPeons	integer count	nothing
827		function	SetZepNextWave		nothing
107		native	ShiftTownSpot	real x, real y	nothing
2135		function	SingleMeleeAttack	boolean needs_exp, boolean has_siege, boolean major_ok, boolean air_units	nothing
2455		function	SkillArrays		integer
127		native	Sleep	real seconds	nothing
1412		function	SleepForever		nothing
1692		function	SleepInCombat		nothing
1681		function	SleepUntilAtGoal		nothing
2010		function	SleepUntilTargetDead	unit target	nothing
1382		function	StaggerSleep	real base, real spread	nothing
779		function	StandardAI	code heroes, code peons, code attacks	nothing
1397		function	StartBuildLoop		nothing
1307		function	StartExpansion	integer qty, integer hall	boolean
79		native	StartGetEnemyBase		nothing
126		native	StartThread	code func	nothing
972		function	StartTownBuilder	code func	nothing
1219		function	StartUnit	integer ask_qty, integer unitid, integer town	boolean
1046		function	StartUpgrade	integer level, integer upgid	boolean
100		native	StopGathering		nothing
1876		function	SuicideOnce	integer easy, integer med, integer hard, integer unitid	nothing
1827		function	SuicideOnPlayer	integer seconds, player p	nothing
1941		function	SuicideOnPlayerEx	integer easy, integer med, integer hard, player p	nothing
1725		function	SuicideOnPlayerWave		nothing
1837		function	SuicideOnPoint	integer seconds, player p, integer x, integer y	nothing
1963		function	SuicideOnPointEx	integer easy, integer med, integer hard, player p, integer x, integer y	nothing
1832		function	SuicideOnUnits	integer seconds, player p	nothing
1952		function	SuicideOnUnitsEx	integer easy, integer med, integer hard, player p	nothing
90		native	SuicidePlayer	player id, boolean check_full	boolean
91		native	SuicidePlayerUnits	player id, boolean check_full	boolean
831		function	SuicideSleep	integer seconds	nothing
124		native	SuicideUnit	integer count, integer unitid	nothing
1887		function	SuicideUnitA	integer unitid	nothing
1895		function	SuicideUnitB	integer unitid, integer playerid	nothing
125		native	SuicideUnitEx	integer ct, integer uid, integer pid	nothing
1903		function	SuicideUnits	integer u1, integer u2, integer u3, integer u4, integer u5, integer u6, integer u7, integer u8, integer u9, integer uA	nothing
1922		function	SuicideUnitsEx	integer playerid, integer u1, integer u2, integer u3, integer u4, integer u5, integer u6, integer u7, integer u8, integer u9, integer uA	nothing
1842		function	SuicideUntilSignal	integer seconds, player p	nothing

BACK TO TOP

T

Line	Constant	Type	Name	Parameters	Return Type
108		native	TeleportCaptain	real x, real y	nothing
1169		function	TownCount	integer base	integer
1164		function	TownCountDone	integer base	integer
1102		function	TownCountEx	integer unitid, boolean only_done, integer townid	integer
1186		function	TownCountTown	integer base, integer townid	integer
29		native	TownHasHall	integer townid	boolean
28		native	TownHasMine	integer townid	boolean
131		native	TownThreatened		boolean
27		native	TownWithMine		integer
744		function	Trace	string message	nothing
751		function	TraceI	string message, integer val	nothing
758		function	TraceII	string message, integer v1, integer v2	nothing
765		function	TraceIII	string message, integer v1, integer v2, integer v3	nothing

BACK TO TOP

U

Line	Constant	Type	Name	Parameters	Return Type
128		native	UnitAlive	unit id	boolean
129		native	UnitInvis	unit id	boolean
42		native	Unsummon	unit unitid	nothing
2442		function	UnsummonAll		nothing
1181		function	UpgradeAll	integer baseid, integer newid	nothing

BACK TO TOP

V

BACK TO TOP

W

Line	Constant	Type	Name	Parameters	Return Type
848		function	WaitForSignal		integer
1296		function	WaitForTown	integer towns, integer townid	nothing
1211		function	WaitForUnits	integer unitid, integer qty	nothing
80		native	WaitGetEnemyBase		boolean
1624		function	WavePrepare	integer unitid	integer

BACK TO TOP

X

BACK TO TOP

Y

BACK TO TOP

Z

BACK TO TOP