Palota: /* ClearRoles */

2025-05-25T16:22:06Z

ClearRoles

← Older revision		Revision as of 16:22, 25 May 2025
Line 217:		Line 217:

	'''See:''' [[Roles]]		'''See:''' [[Roles]]

			----

			===ClearUsePoints===
			Deletes all use points of the map goal.

			'''Parameters:''' none

			'''Returns:''' none

			'''Example:''' <syntaxhighlight lang="java">
			mg.ClearUsePoints();</syntaxhighlight>

	----		----

Palota: /* GetRange, GetRangeAABB */

2025-05-25T16:19:26Z

GetRange, GetRangeAABB

@@ Line 398: / Line 398: @@
 ----
 ===GetTagName===
 Gets the tag name of the map goal. This is usually a mash of the entity name and goal type.

Palota: /* SetRange */

2025-05-25T16:14:44Z

SetRange

← Older revision		Revision as of 16:14, 25 May 2025
Line 657:		Line 657:
	----		----
	===SetRange===		===SetRange===
	Sets the range for a script based map goal. The QueryGoals functions does not return goals which are out of range. Default range for all goals is ~~0 which means~~ unlimited. Goals will not be interrupted if the range changes after the bot has activated the goal.		Sets the range for a script based map goal. 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.

	'''Parameters:''' (~~range~~)		'''Parameters:''' (int or AABB)

	'''Returns:''' none		'''Returns:''' none

	'''Example:''' <syntaxhighlight lang="java">		'''Example:''' <syntaxhighlight lang="java">
	mg.SetRange(1000);</syntaxhighlight>		mg.SetRange(1000);
			mg.SetRange(AABB(1369,2165,30, 4100,3700,350));

			//reset to unlimited
			mg.SetRange(0);
			mg.SetRange(AABB());
			</syntaxhighlight>

	'''Utility function:''' Util.SetGoalRange		'''Utility function:''' Util.SetGoalRange
	----		----

	===SetRemoveFlag===		===SetRemoveFlag===
	Marks the goal for removal.		Marks the goal for removal.

Palota: /* SetBounds */

2025-05-25T15:55:39Z

SetBounds

@@ Line 586: / Line 586: @@
 '''Example:''' <syntaxhighlight lang="java">
   this.SetBaseGoalType("mapgoal_camp.gm");</syntaxhighlight>
 ----

Palota: /* SetRoles */

2024-12-01T07:53:08Z

SetRoles

← Older revision		Revision as of 07:53, 1 December 2024
Line 695:		Line 695:
	Sets the roles that are allowed to use this goal.		Sets the roles that are allowed to use this goal.

	'''Parameters:''' (roleId~~, ...~~)		'''Parameters:''' (roleId or table)

	'''Returns:''' none		'''Returns:''' none
Line 702:		Line 702:
	mg.SetRoles(ROLE.DEFENDER);</syntaxhighlight>		mg.SetRoles(ROLE.DEFENDER);</syntaxhighlight>

	'''Utility functions:''' SetGoalRole, Util.SetRoleForGroup~~, Util.SetRoleForTable~~		'''Utility functions:''' SetGoalRole, Util.SetRoleForGroup

	'''See:''' [[Roles]]		'''See:''' [[Roles]]

Palota: 1 revision imported

2023-02-13T07:02:32Z

1 revision imported

← Older revision	Revision as of 07:02, 13 February 2023
(No difference)

Palota at 08:12, 14 July 2021

2021-07-14T08:12:31Z

New page

{{process header
| title = MapGoal Functions
| section =
| previous = [[Omni-bot_Script_Reference | Script Reference]]
| next =
| shortcut =
| notes =
}}
{{TOCright}}
==Map Goal Properties==
----
===CreateOnLoad===
False to not create the goal at load time, but keep the data around for when created by the interface.

----
===DefaultPriority===
Default priority of the goal, if no class/team specific priorities.

----
===DefaultRenderHeight===
Goal height offset where rendering will take place.

----
===DefaultRenderRadius===
Maximal distance from player to display text (goal options).

----
===DisableForControllingTeam===
Goal will be made unavailable for the team which controls it (GetOwner). It is used by CHECKPOINT goal.

----
===DontSave===
Don't save this goal into the map goal script.

----
===DynamicOrientation===
Goal should update its orientation from its entity. It is used by BUILD goal to repair vehicles.

----
===DynamicPosition===
Goal should update its position from its entity. It is used by BUILD goal to repair vehicles.

----
===ExtraDebugText===
Additional debug text to render in RenderDefault function.

----
===GoalState===
Gets the goal state.

----
===GoalStateFunction===
internal

----
===GoalType===
Type of goal.

----
===InUse===
Goal is inuse and should not be chosen.

----
===MarkForRemoval===
Mark the goal for deletion.

----
===MinRadius===
Minimum allowed radius of the goal.

----
===Radius===
Radius of the goal.

----
===RemoveWithEntity===
Goal should be removed if its entity is removed. Default is true. It is used by FLAG, FLAGRETURN, DEFUSE goals.

----
===RenderDefaultCurrentAvailability===
Draw the current availability of the goal.

----
===RenderDefaultGroup===
Draw the group of the goal.

----
===RenderDefaultInitialAvailability===
Draw the initial availability of the goal.

----
===RenderDefaultName===
Draw the name of the goal.

----
===RenderDefaultRadius===
Draw the radius of the goal.

----
===RenderDefaultRole===
Draw the roles for the goal.

----
===RenderGoal===
Enable rendering for this goal. It is set by console command /bot draw_goals

----
===RenderRandomUsePoint===
Draw whether or not the goal randomly selects a usepoint.

----
===RenderRangeLimit===
Draw whether or not the goal randomly selects a usepoint.

----
===RenderRoutes===
Enable rendering of the routes for this goal. It is set by console command /bot draw_goalroutes

'''See:'''
[[Template:Baserouting|Routing]]

----

===RolePriorityBonus===
Role priority bonus of the goal, for users matching role.

'''See:'''
[[Roles]]

----

===Version===
Gets the goal version. Omni-bot 0.8 sets goal version to 1.

----
===SerialNum===
Auto generated unique serial number of the goal.

----

==Map Goal Callbacks==
----
===InitNewGoal===
Called on goal creation (command /bot goal_create) to initialize any internal variables and set properties to default values.
For example, camping goals can initialize aim vectors to the player facing.

----
===UpgradeVersion===
Called after the goal properties have been loaded from a goals file. This function should validate schema and upgrade the goal to the latest used version.

----
===Render===
Called when draw_goals is enabled for this goal. Used to render itself.

----
===Update===
Called every frame to update the state of the goal if needed. For example, GRENADE goal calls TraceLine function to check if the goal has been destroyed.

----
===SaveToTable===
Called when the goals are saved to a file. Allows the goal to serialize persistent information.

----
===SetProperty===
Called on command /bot goal_setproperty x y, where x is a property name and y is a value or keyword.

----
===Help===
Called on commands /bot goal_help or /bot goal_create to print requirements and available properties for the goal.

----
===HudDisplay===
Called when debug window is enabled and goal is highlighted to create gui elements for debug visualization.

----

==Map Goal Functions==
----
===AddRoute===
'''See:'''
[[Template:Baserouting|Routing]]

'''Parameters:''' (start, end, weight)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.AddRoute("ROUTE_spawn", "ROUTE_gate", 1.0);</syntaxhighlight>

'''Utility function:''' Util.Routes
----

===AddUsePoint===
Adds a use point to the goal. Use points are used by RouteTo function. The goal can have multiple use points. Bots choose the nearest use point if goal property RandomUsePoint is false.

'''Parameters:''' (Vector3, relative[optional, default false])

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.AddUsePoint(Vector3(10,50,0), true);</syntaxhighlight>

'''Utility functions:''' Util.AddUsePoint, Util.AddUseWp

----
===ClearRoles===
Removes the given roles from this goal.

'''Parameters:''' (roleId, ...)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.ClearRoles(ROLE.DEFENDER1, ROLE.DEFENDER2);</syntaxhighlight>

'''Utility functions:''' ClearGoalRole, Util.ClearRoleForGroup, Util.ClearRoleForTable

'''See:''' [[Roles]]

----

===CreateGuiFromSchema===
Used in HudDisplay callback if debug window is enabled.

'''Example:''' <syntaxhighlight lang="java">
this.CreateGuiFromSchema(this.Schema);</syntaxhighlight>

----
===DeleteIfEntityFlag===
Sets one or more entity flags that will cause the goal to be deleted.

'''Parameters:''' (entFlagId, ...)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.DeleteIfEntityFlag(ENTFLAG.DISABLED);</syntaxhighlight>

----
===DisableGoal===
Sets whether the goal is currently disabled.

'''Parameters:''' (true/false)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.DisableGoal(true);</syntaxhighlight>

----
===DisableIfEntityFlag===
Sets one or more entity flags that will cause the goal to be disabled.

'''Parameters:''' (entFlagId, ...)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.DisableIfEntityFlag(ENTFLAG.DISABLED);</syntaxhighlight>

----
===GetCenterBounds===
Gets the center of the bounding box.

'''Parameters:''' none

'''Returns:''' Vector3

'''Example:''' <syntaxhighlight lang="java">
center = mg.GetCenterBounds();</syntaxhighlight>

----
===GetEntity===
Gets the entity of the map goal.

'''Parameters:''' none

'''Returns:''' GameEntity

'''Example:''' <syntaxhighlight lang="java">
ent = mg.GetEntity();</syntaxhighlight>

----
===GetFacing===
Gets the facing of the map goal.

'''Parameters:''' none

'''Returns:''' Vector3 facing

'''Example:''' <syntaxhighlight lang="java">
face = mg.GetFacing();</syntaxhighlight>

----
===GetGoalPriority===
Gets the priority for a given class/team. Default priority is returned if class or team is 0.

If the parameter is bot, role priority bonus is added if the bot has any of the goals roles.

'''Parameters:''' (bot)

'''Parameters:''' (teamId, classId)

'''Returns:''' float

'''Example:''' <syntaxhighlight lang="java">
priority = mg.GetGoalPriority(bot);
// OR
priority = mg.GetGoalPriority(TEAM.AXIS,CLASS.MEDIC);</syntaxhighlight>

----
===GetGoalState===
Gets the goal state of the map goal.

'''Parameters:''' none

'''Returns:''' goal state id

'''Example:''' <syntaxhighlight lang="java">
state = mg.GetGoalState();</syntaxhighlight>

----
===GetGoalType===
Gets goal type. Examples: Attack, BUILD, CapPoint, PLANT.

'''Parameters:''' none

'''Returns:''' string

'''Example:''' <syntaxhighlight lang="java">
type = mg.GetGoalType();</syntaxhighlight>

----
===GetGroupName===
Gets the current group this goal is assigned to.

'''Parameters:''' none

'''Returns:''' string

'''Example:''' <syntaxhighlight lang="java">
group = mg.GetGroupName();</syntaxhighlight>

----
===GetName===
Gets the name of the map goal.

'''Parameters:''' none

'''Returns:''' name of mapgoal

'''Example:''' <syntaxhighlight lang="java">
name = mg.GetName();</syntaxhighlight>

----
===GetNumUsePoint===
Gets the number of use points the goal has.

'''Parameters:''' none

'''Returns:''' # use points

'''Example:''' <syntaxhighlight lang="java">
n = mg.GetNumUsePoint();</syntaxhighlight>

----
===GetOwner===
Gets the owner of the map goal. Typically someone that is carrying it.

'''Parameters:''' none

'''Returns:''' Owner GameId, or null if no owner

'''Example:''' <syntaxhighlight lang="java">
owner = mg.GetOwner();</syntaxhighlight>

----
===GetPosition===
Gets the position of the map goal.

'''Parameters:''' none

'''Returns:''' Vector3 position

'''Example:''' <syntaxhighlight lang="java">
pos = mg.GetPosition();</syntaxhighlight>

----
===GetRadius===
Gets the radius of the map goal.

'''Parameters:''' none

'''Returns:''' float radius

'''Example:''' <syntaxhighlight lang="java">
radius = mg.GetRadius();</syntaxhighlight>

----
===GetTagName===
Gets the tag name of the map goal. This is usually a mash of the entity name and goal type.

'''Parameters:''' none

'''Returns:''' tag name

'''Example:''' <syntaxhighlight lang="java">
tag = mg.GetTagName();</syntaxhighlight>

----
===GetTypeName===
Gets the type name of the map goal.

'''Parameters:''' none

'''Returns:''' type name

'''Example:''' <syntaxhighlight lang="java">
type = mg.GetTypeName();</syntaxhighlight>

----
===GetUsePoint===
Gets a use point, by index. If no index provided, returns a random one.

'''Parameters:''' (index<optional>)

'''Returns:''' Vector3 use point

'''Example:''' <syntaxhighlight lang="java">
pt = mg.GetUsePoint();
// OR
pt = mg.GetUsePoint(2);</syntaxhighlight>

----
===HasRole===
Returns true if the goal has any of the roles provided as parameters.

'''Parameters:''' (roleId, ...)

'''Returns:''' true/false

'''Example:''' <syntaxhighlight lang="java">
if(mg.HasRole(ROLE.ATTACKER))
{
}</syntaxhighlight>

'''See:''' [[Roles]]

----

===IsAvailable===
Checks if the map goal is currently available to a certain team.

'''Parameters:''' (team id)

'''Returns:''' true if goal is available for team, false if not

'''Example:''' <syntaxhighlight lang="java">
if(mg.IsAvailable(TEAM.RED))
{
}</syntaxhighlight>

----
===IsAvailableInitial===
Is goal available for team initially (before OnMapLoad is executed).

'''Parameters:''' (team id)

'''Returns:''' true if goal is available for team, false if not

'''Example:''' <syntaxhighlight lang="java">
if (mg.IsAvailableInitial(TEAM.RED))
{
}</syntaxhighlight>

----
===IsDisabled===
Gets whether the goal is currently disabled.

'''Parameters:''' none

'''Returns:''' true/false

'''Example:''' <syntaxhighlight lang="java">
if(mg.IsDisabled())
{
}</syntaxhighlight>

----
===LimitToWeapon===
Adds a list of weapons that are required from any user of the goal.

Warning: This function does not work for weapons that have ID greater than 63.

'''Parameters:''' (weaponId, ...)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.LimitToWeapon(WEAPON.FG42);</syntaxhighlight>

----
===MaxUsers_InProgress===
Get or set the max number of users that can go to the goal.

'''Parameters:''' none or (integer)

'''Returns:''' integer

'''Example:''' <syntaxhighlight lang="java">
num = mg.MaxUsers_InProgress();
// OR
mg.MaxUsers_InProgress(2);</syntaxhighlight>

'''Utility functions:''' Util.SetMaxUsers, Util.SetMaxUsersInProgress, Util.GetMaxUsersInProgress, Util.SetPercentInProgress

----
===MaxUsers_InUse===
Get or set the max number of users that can use the goal after they come to the goal position.

'''Parameters:''' none or (integer)

'''Returns:''' integer

'''Example:''' <syntaxhighlight lang="java">
num = mg.MaxUsers_InUse();
// OR
mg.MaxUsers_InUse(1);</syntaxhighlight>

'''Utility functions:''' Util.SetMaxUsers, Util.SetMaxUsersInUse, Util.GetMaxUsersInUse

----
===RenderDefault===
Draws goal name, radius, availability, use points, ExtraDebugText, ...

'''Parameters:''' none

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.RenderDefault();</syntaxhighlight>

----
===ResetGoalPriorities===
Clears all the current priorities.

'''Parameters:''' none

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.ResetGoalPriorities();</syntaxhighlight>

----
===SetAvailable===
Sets the map goal available for a certain team.

NOTE: Map scripts usually use global function SetAvailableMapGoals instead of calling SetAvailable directly on map goal object.

'''Parameters:''' (team id, true/false)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetAvailable(TEAM.RED, false);</syntaxhighlight>

----
===SetAvailableInitial===
Sets goal available for team initially.

'''Parameters:''' (team id, true/false)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetAvailableInitial(TEAM.AXIS, true);</syntaxhighlight>

----
===SetBaseGoalType===
Clones a base goal type. Should be done first thing in goal script.

'''Parameters:''' (fileName)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
this.SetBaseGoalType("mapgoal_camp.gm");</syntaxhighlight>

----
===SetBounds===
Sets the bounds for a map goal. This is the local space bounds. It will automatically be transformed to the world position of the map goal.

'''Parameters:''' (AABB)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
AABB aabb;
// initialize it somehow
mg.SetBounds(aabb);</syntaxhighlight>

----
===SetEntity===
Sets the entity for a map goal. It is usually not needed because most entities are detected automatically.

'''Parameters:''' (entity)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
GetGoal("MOUNTMG42_assault_tower_mg").SetEntity(GetEntityByName("assault_tower_mg"));;</syntaxhighlight>

----
===SetFacing===
Sets the facing for a map goal.

'''Parameters:''' (Vector3)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetFacing(Vector3(1,0,0));</syntaxhighlight>

----
===SetGoalPriority===
Sets the priority for a given class/team. The first parameter can be 0 to set priority for all teams. The second parameter can be 0 to set priority for all classes.

NOTE: Map scripts usually use global function SetGoalPriority instead of calling SetGoalPriority directly on map goal object.

'''Parameters:''' (teamId, classId, priority)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetGoalPriority(TEAM.ALLIES, CLASS.SOLDIER, 0.8);</syntaxhighlight>

----
===SetGroupName===
Sets the current group this goal is assigned to.

'''Parameters:''' (groupName)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetGroupName("group1");</syntaxhighlight>

----
===SetPosition===
Sets the position for a map goal.

'''Parameters:''' (Vector3)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetPosition(Vector3(10,10,10));</syntaxhighlight>

----
===SetRadius===
Sets the radius for a map goal.

'''Parameters:''' (radius)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetRadius(65);</syntaxhighlight>

----
===SetRange===
Sets the range for a script based map goal. The QueryGoals functions does not return goals which are out of range. Default range for all goals is 0 which means unlimited. Goals will not be interrupted if the range changes after the bot has activated the goal.

'''Parameters:''' (range)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetRange(1000);</syntaxhighlight>

'''Utility function:''' Util.SetGoalRange
----
===SetRemoveFlag===
Marks the goal for removal.

'''Parameters:''' (true/false)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetRemoveFlag(true);</syntaxhighlight>

----
===SetRoles===
Sets the roles that are allowed to use this goal.

'''Parameters:''' (roleId, ...)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetRoles(ROLE.DEFENDER);</syntaxhighlight>

'''Utility functions:''' SetGoalRole, Util.SetRoleForGroup, Util.SetRoleForTable

'''See:''' [[Roles]]

----

==Obsolete Functions==

===GetBounds===
Gets the AABB bounds of the map goal.

'''Parameters:''' none

'''Returns:''' AABB

'''Example:''' <syntaxhighlight lang="java">
bounds = mg.GetBounds();</syntaxhighlight>

----
===GetLocalBounds===
Gets the local space bounds of the map goal.

'''Parameters:''' none

'''Returns:''' AABB bounds

'''Example:''' <syntaxhighlight lang="java">
localbounds = mg.GetLocalBounds();</syntaxhighlight>

----
===GetMatrix===
Gets the Matrix3 transform of the map goal.

'''Parameters:''' none

'''Returns:''' Matrix3 transform

'''Example:''' <syntaxhighlight lang="java">
m = mg.GetMatrix();</syntaxhighlight>

----
===SetEnableDraw===
Enables debug rendering for this map goal.

'''Parameters:''' (true/false)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
mg.SetEnableDraw(true);</syntaxhighlight>

----
===SetMatrix===
Sets the matrix for a map goal.

'''Parameters:''' (Matrix3)

'''Returns:''' none

'''Example:''' <syntaxhighlight lang="java">
m = Matrix3();
// initialize it somehow
mg.SetMatrix(m);</syntaxhighlight>

----