Utility Functions - Revision history

Palota: /* ETUtil.SetCabinets */

2025-06-30T08:59:04Z

ETUtil.SetCabinets

← Older revision		Revision as of 08:59, 30 June 2025
Line 507:		Line 507:

	Sets AimMode property of MOUNT goal. Valid values are "velocity", "opposite", "random" or Vector3.		Sets AimMode property of MOUNT goal. Valid values are "velocity", "opposite", "random" or Vector3.

	~~==== ETUtil.SetCabinets ====~~

	~~<syntaxhighlight lang="java">~~
	~~syntax: ETUtil.SetCabinets();~~
	~~</syntaxhighlight>~~

	~~disables health & ammo cabinets for Medic & FieldOp Classes~~

	==== ETUtil.SetExcludeIndexes ====		==== ETUtil.SetExcludeIndexes ====

Palota: /* Util.SetGoalRange */

2025-06-08T07:39:49Z

Util.SetGoalRange

← Older revision		Revision as of 07:39, 8 June 2025
Line 321:		Line 321:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
	syntax: Util.SetGoalRange( goalNames, distance );		syntax: Util.SetGoalRange( goalNames, distance or AABB );
	~~example~~: Util.SetGoalRange("GRENADE_tower.*", 800);</syntaxhighlight>		examples:
			Util.SetGoalRange("GRENADE_tower.*", 800);
			Util.SetGoalRange("PLANT_SideGate", AABB(-2785,-3579,65,2702,-1306,257));
			//reset to unlimited
			Util.SetGoalRange("GRENADE_tower.*", 0);
			Util.SetGoalRange("PLANT_SideGate", AABB());</syntaxhighlight>

	sets the range for map goals. The goals ~~will not be available for bots that~~ are out of range. Default range for all goals is ~~0 which means~~ unlimited.		sets the range for map goals. It can be int radius or AABB box or both. The QueryGoals functions does not return goals which are out of range. Default range for all goals is unlimited. Goals will not be interrupted if the range changes after the bot has already activated the goal.

	==== Util.SetGroup ====		==== Util.SetGroup ====

Palota: /* ETUtil.IsTeamDead */

2025-05-25T17:31:07Z

ETUtil.IsTeamDead

← Older revision		Revision as of 17:31, 25 May 2025
Line 472:		Line 472:

	returns true if all players on the given team are dead.		returns true if all players on the given team are dead.

			==== ETUtil.KillTeam ====

			<syntaxhighlight lang="java">
			syntax: ETUtil.KillTeam( team, <optional maxTime> );
			example: ETUtil.KillTeam( TEAM.AXIS, 15 );
			</syntaxhighlight>

			waits for next respawn and then kills all bots in the team, but only if time to next respawn is not greater than maxTime.

	==== ETUtil.LosingChat ====		==== ETUtil.LosingChat ====

Palota: /* ETUtil.WinningChat */

2025-05-25T17:14:34Z

ETUtil.WinningChat

← Older revision		Revision as of 17:14, 25 May 2025
Line 539:		Line 539:

	This function is deprecated since version 0.82 because it only kills bot and does not change his weapon.		This function is deprecated since version 0.82 because it only kills bot and does not change his weapon.

			==== ETUtil.WaitForSpawn ====

			<syntaxhighlight lang="java">
			syntax: ETUtil.WaitForSpawn(Team);
			example: ETUtil.WaitForSpawn( TEAM.ALLIES );
			</syntaxhighlight>

			Sleeps until next respawn of the team. Returns 0.15 seconds before respawn.

	==== ETUtil.WinningChat ====		==== ETUtil.WinningChat ====

Palota: /* ETUtil.SelectWeapon */

2025-05-25T17:07:46Z

ETUtil.SelectWeapon

← Older revision		Revision as of 17:07, 25 May 2025
Line 484:		Line 484:
	==== ETUtil.SelectWeapon ====		==== ETUtil.SelectWeapon ====

	~~<syntaxhighlight lang="java">~~		This function does not work since version 0.82. Now you have to use [[Utility_Functions#WeaponTable\|WeaponTable.SetWeaponAvailability]].
	~~syntax: ETUtil.SelectWeapon(bot, weapon);~~
	~~example: ETUtil.SelectWeapon(bot, WEAPON.PANZERFAUST);</syntaxhighlight>~~

	This function ~~is deprecated~~ since version 0.82 ~~because it only kills bot and does not change his weapon~~.

	==== ETUtil.SetAimModeForMount====		==== ETUtil.SetAimModeForMount====

Palota: /* ETUtil.GetReinforceTime */

2025-05-25T16:55:42Z

ETUtil.GetReinforceTime

← Older revision		Revision as of 16:55, 25 May 2025
Line 438:		Line 438:

	can be used to determine if a team has enough of a critical class for the map		can be used to determine if a team has enough of a critical class for the map

			==== ETUtil.GetReinforceTime ====

			<syntaxhighlight lang="java">
			syntax: ETUtil.GetReinforceTime(TEAM.AXIS);
			</syntaxhighlight>

			returns time to next respawn, or null if no bot exists in the team.

	==== ETUtil.GetTimeElapsed ====		==== ETUtil.GetTimeElapsed ====

Palota: /* Util.UpdateSwitchData */

2024-12-17T07:43:43Z

Util.UpdateSwitchData

← Older revision		Revision as of 07:43, 17 December 2024
Line 408:		Line 408:
	==== Util.UpdateSwitchData ====		==== Util.UpdateSwitchData ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Switch_Goal]]
	~~syntax: Util.UpdateSwitchData();</syntaxhighlight>~~

	~~this~~ function ~~must be called from OnMapLoad if Map.Switches~~ is ~~defined~~.

	~~see also:~~ [[~~Paththrough UseSwitch~~]]

	==== Util.WpNameInfo ====		==== Util.WpNameInfo ====

Palota: deprecated functions

2024-12-01T07:40:07Z

deprecated functions

← Older revision		Revision as of 07:40, 1 December 2024
Line 47:		Line 47:
	==== Util.BotHasAnyRole ====		==== Util.BotHasAnyRole ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Bot#HasRole\|HasRole]]
	~~syntax: Util~~.~~BotHasAnyRole(bot);~~
	~~example: if ( Util.BotHasAnyRole(bot) ) {~~
	~~</syntaxhighlight>~~

	~~returns true if bot has any role.~~

	~~see also:~~ [[~~Roles~~]] ~~Page~~

	==== Util.CanBotSnipe ====		==== Util.CanBotSnipe ====
Line 127:		Line 120:
	==== Util.ClearRoleForTable ====		==== Util.ClearRoleForTable ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Bot_Library#ClearGoalRole\|ClearGoalRole]]
	~~syntax: Util~~.~~ClearRoleForTable( tbl, <role or table> );~~
	~~example: Util.ClearRoleForTable( someTable, ROLE.DEFENDER );~~
	~~</syntaxhighlight>~~

	~~used to remove roles from a given table of goals~~

	~~see also:~~ [[~~Roles~~]] ~~Page~~

	==== Util.DisableGoal ====		==== Util.DisableGoal ====
Line 232:		Line 218:
	==== Util.IgnoreTargetGoal ====		==== Util.IgnoreTargetGoal ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Bot#IgnoreTarget\|IgnoreTarget]]
	~~syntax:Util~~.~~IgnoreTargetGoal( bot, goalname, time );~~
	~~example: Util.IgnoreTargetGoal( bot, "MOVER_bird1" );~~
	~~example: Util.IgnoreTargetGoal( bot, "MOVER_bird1", 9999 );~~
	~~</syntaxhighlight>~~

	~~used to stop bots shooting at game entities such as movers, Normally added in OnBotJoin~~

	==== Util.IgnoreTargetGoalTable ====		==== Util.IgnoreTargetGoalTable ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Bot#IgnoreTarget\|IgnoreTarget]]
	~~syntax: Util~~.~~IgnoreTargetGoalTable(bot, <table name>);~~
	~~example: Util.IgnoreTargetGoalTable(bot, Map.Movers);~~
	~~</syntaxhighlight>~~

	~~used to stop bots shooting at game entities listed in a map table, Normally added in OnBotJoin~~

	==== Util.IsBot ====		==== Util.IsBot ====
Line 352:		Line 327:

	==== Util.SetGroup ====		==== Util.SetGroup ====

	This function is deprecated. Use [[Bot_Library#SetGoalGroup\|SetGoalGroup]]		This function is deprecated. Use [[Bot_Library#SetGoalGroup\|SetGoalGroup]]

	==== Util.SetGroupForTable ====		==== Util.SetGroupForTable ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Bot_Library#SetGoalGroup\|SetGoalGroup]]
	~~syntax: Util.SetGroupForTable( tbl, group );~~
	~~example: Util.SetGroupForTable( someTable, "myGroup" );~~
	~~</syntaxhighlight>~~

	~~add each goal in the given table of goals to the given group~~.

	==== Util.SetMaxUsers ====		==== Util.SetMaxUsers ====
Line 423:		Line 394:
	==== Util.SetRoleForTable ====		==== Util.SetRoleForTable ====

	~~<syntaxhighlight lang="java">~~		This function is deprecated. Use [[Bot_Library#SetGoalRole\|SetGoalRole]]
	~~syntax: Util.SetRoleForTable( <goal table>, <role or table> );~~
	~~example: Util.SetRoleForTable( someTable, ROLE.DEFENDER );~~
	~~</syntaxhighlight>~~

	~~sets the given roles for the given table of goals~~.

	see also: [[Roles]] Page		see also: [[Roles]] Page

Palota: /* Util.SetGroup */

2024-12-01T07:20:10Z

Util.SetGroup

← Older revision		Revision as of 07:20, 1 December 2024
Line 352:		Line 352:

	==== Util.SetGroup ====		==== Util.SetGroup ====
			This function is deprecated. Use [[Bot_Library#SetGoalGroup\|SetGoalGroup]]
	~~<syntaxhighlight lang="java">~~
	~~syntax: Util~~.~~SetGroup(goalname, groupname);~~
	~~example: Util.SetGroup("somegoalname", "somegroupname");</syntaxhighlight>~~

	~~this function will add a given goal to a given groupname~~

	==== Util.SetGroupForTable ====		==== Util.SetGroupForTable ====

Palota: /* ETUtil.StopSniping */

2024-07-10T16:32:06Z

ETUtil.StopSniping

← Older revision		Revision as of 16:32, 10 July 2024
Line 561:		Line 561:

	used to make a bot start from a certain vehicle offset in mover goals that have offsets defined. Normally set in OnMapLoad then reset inside a trigger. Used only by goals BUILD, ESCORT, MOUNT, RIDE.		used to make a bot start from a certain vehicle offset in mover goals that have offsets defined. Normally set in OnMapLoad then reset inside a trigger. Used only by goals BUILD, ESCORT, MOUNT, RIDE.

	~~==== ETUtil.StopSniping ====~~

	~~<syntaxhighlight lang="java">~~
	~~syntax: ETUtil.StopSniping();</syntaxhighlight>~~

	~~This function is deprecated since version 0.82 because it only kills bot and does not change his weapon.~~

	==== ETUtil.SuicideSpawn ====		==== ETUtil.SuicideSpawn ====