AskClient function

[Quintaxel]

The function AskClient (strName) is not documented in Calvin's guide.
The only usage of this function I know so far is AskClient("SetCamera (x,y)");

Question: Has anyone seen another use of the AskClient function? Are other arguments of this function know ?

[keepitsimple]

No. This the only function I know.

It's however a useful function. If want draw the player view to specific point on the map. Where ever the view of player was it is temporary move to this point. So he get next to objective arrow also a directly view on a point. Get this view right is a bit of a hassle. But with some trail and error you can get right.  

[Quintaxel]

thx, keepitsimple,
Just found that HighLightControl (int) is another function that can be an argument of the AskClient function.
The integer values of the function HighLightControl (int) are linked to the buttons in the user interface.

eg. AskClient( "HighlightControl(20022)") will make the button 'demine' blink in the user interface.
Not very useful unless you make a tutorial.

[Quintaxel]

GetSelectedUnits () is another function that can be used as an argument of the function AskClient ()
The syntax is :

AskClient("GetSelectedUnits()")

The function will capture the iScriptId of the units which are selected by the player.
To get the iScriptId in the Lua script another function is required, GetSelectedUnitsFeedBack(n). The integer value n returns the iScriptId of the slected units.

I'll try to write a short script to explain how it works.

This function could be used a option switches. 
It should be possible to write a script that offers the player a choice of reinforcements based upon the unit he selects.

[Quintaxel]

Here's a small script to demonstrate the use of functions mentioned above.
The idea is that the player selects on of the 3 units on the map.
His choice determines the type of Reinforcements he gets.
Maybe this could be interesting in scripts where the player has to make a choice depending on the losses he suffers or the strategy he wants to follow.


function GetSelectedUnitsFeedBack(n)
if (n == 100) then
DisplayTrace ("selected unit is %g",n );
LandReinforcement (101);
KillScript ("CheckSelected");
elseif (n == 200) then
DisplayTrace ("selected unit is %g",n );
LandReinforcement (201);
KillScript ("CheckSelected");
elseif  (n == 300) then
DisplayTrace ("selected unit is %g",n );
LandReinforcement (301);
KillScript ("CheckSelected");
end;
end;

function Init ()
DisplayTrace ("Select a unit to get Reinforcements");
SetIGlobalVar ("Reinf", 0);
RunScript ("CheckSelected",2000);
end;

function CheckSelected()
AskClient("GetSelectedUnits()");
end;




Note that that the function  GetSelectedUnitsFeedBack(n) runs automatically, just like the funtion Init ()







The script is very basic but could be refined into something useful. Here you can find a demo map and script.

[[BMG]Neutro]

This is very useful thank you for sharing !

thx, keepitsimple,
Just found that HighLightControl (int) is another function that can be an argument of the AskClient function.
The integer values of the function HighLightControl (int) are linked to the buttons in the user interface.

eg. AskClient( "HighlightControl(20022)") will make the button 'demine' blink in the user interface.
Not very useful unless you make a tutorial.

Will you integrade a list in your CHM of the possible numbers of all aviable buttons for the "HighLightControl" command?

[Quintaxel]

If I know a code then I will add it.

[[BMG]Neutro]

Display

AskClient("HighlightIndicator(10)"); = Hit Points

AskClient("HighlightIndicator(11)"); = Primary Ammo

AskClient("HighlightIndicator(12)"); = Secondary Ammo

AskClient("HighlightIndicator(13)"); = Unit Experince

Generally

AskClient("HighlightControl(20001)"); = Forced Movement (Q)

AskClient("HighlightControl(20002)"); = (Force) Attack (R)

AskClient("HighlightControl(20003)"); = Agressive Movement (A)

AskClient("HighlightControl(20006)"); = Turn Rotate (S)

AskClient("HighlightControl(20017)"); = Stand Ground (E)

AskClient("HighlightControl(20016)"); = Entrench (F)

AskClient("HighlightControl(20010)"); = Ambush (D)

ARTY

AskClient("HighlightControl(20012)");  = Range Fire (X)

AskClient("HighlightControl(20013)"); = Supressive Fire (Y)

AskClient("HighlightControl(20073)"); = Choose Ammo (C) open submenu

AskClient("HighlightControl(20057)"); = Smoke Shells (W)

AskClient("HighlightControl(20055)"); = Damage Shells (Q)

TRUCK

AskClient("HighlightControl(20005)"); = Unload Soldiers  (Y)

AskClient( "HighlightControl(20027)" ); = Resupply (X)

AskClient( "HighlightControl(20036)" ); = Reinforce (Soldiers) (C)

AskClient( "HighlightControl(20026)" ); = Repair (X)

AskClient( "HighlightControl(20022)" ); = Clear Mines (V)

AskClient( "HighlightControl(20071)" ); = Lay Mines (C) open submenu
AskClient( "HighlightControl(20021)" ); = Lay Anti Tank Mine (W)

AskClient( "HighlightControl(20070)" ); = Build (Y) open submenu
AskClient( "HighlightControl(20029)" ); = Build Anti Tank Obstacle (X)

INF

AskClient("HighlightControl(20072)"); = Formation (Y) open submenu

AskClient("HighlightControl(20051)"); = March Formation (R)

AskClient("HighlightControl(20052)")  = Defensive Formation (E)

AskClient("HighlightControl(20053)"); = Agressive Formation (W)

AskClient("HighlightControl(20050)"); = Defaulft Formation (Q)

AskClient("HighlightControl(20054)"); = Sneak (Sniper) Formation (A)

AskClient("HighlightControl(20034)"); = Observe (Binocular) (W)

AskClient("HighlightControl(20061)"); = Disband (Squad) (C)

AskClient("HighlightControl(20062)"); = Form Squad (C)

PLANES

AskClient("HighlightControl(20031)"); = Fighter (E)

AskClient("HighlightControl(20032)"); = Scout (Q)

AskClient("HighlightControl(20035)"); = Groundattack Plane (R)

AskClient("HighlightControl(20030)"); = Bomber (W)

AskClient("HighlightControl(20033)"); = Paratroopers (A)

Hello, this are all commands i could find so far in all tutorials and some missions of the following games....

BK Games Checked:

Blitzkrieg

Panzerkrieg Gold Edition

Talvisota - Icy Hell

Cuban Missile Crisis_Ice Crusade

Cuban Missile Crisis_The Aftermath

Stalingrad

FUN FACT

i found this row in on of the lua tutorial files.... looks like originally their planned a morale system.... 

-- about morale - old, EXP now
function Objective8()
AskClient("HighlightIndicator(13)");

[Quintaxel]

Great work, I will include these codes in the CHM help file.