Dota 2 Workshop Tools/Scripting/API/Global.FindUnitsInRadius: Difference between revisions
< Dota 2 Workshop Tools | Scripting | API
Jump to navigation
Jump to search
RoyAwesome (talk | contribs) (Dota_Lebot push: Updated Page) |
(Undo revision 190720 by RoyAwesome (talk) since the previous information was more useful.) |
||
Line 39: | Line 39: | ||
| int | | int | ||
| teamNumber | | teamNumber | ||
| | | Your Unit's Team. Refer [https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/Scripting/Constants#Teams Here] | ||
|- | |- | ||
| Vector | | Vector | ||
| position | | position | ||
| | | Point in dota 2 map about which you want to center your search. Use unit:GetAbsOrigin() to center it about a unit. | ||
|- | |- | ||
| handle | | handle | ||
Line 51: | Line 51: | ||
| float | | float | ||
| radius | | radius | ||
| | | The search radius. (FIND_UNITS_EVERYWHERE means the radius will cover the whole map. Refer to more [https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/Scripting/Constants#Find_Types Here]) | ||
|- | |- | ||
| int | | int | ||
| teamFilter | | teamFilter | ||
| | | This will be with respect to team on the first parameter. Refer [https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/Scripting/Constants#AbilityUnitTargetTeam Here] | ||
|- | |- | ||
| int | | int | ||
| typeFilter | | typeFilter | ||
| | | Types of units you want to include/exclude in search. Refer [https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/Scripting/Constants#AbilityUnitTargetType Here] | ||
|- | |- | ||
| int | | int | ||
| flagFilter | | flagFilter | ||
| | | Include/Exclude units which if respectilely flagged. Refer [https://developer.valvesoftware.com/wiki/Dota_2_Workshop_Tools/Scripting/Constants#Unit_Target_Flags Here] | ||
|- | |- | ||
| int | | int | ||
Line 76: | Line 76: | ||
== Returns == | == Returns == | ||
A table containing the found units. If no units are found, <code>FindUnitsInRadius</code> returns an empty table; it does not return <code>nil</code>. |
Revision as of 21:47, 7 February 2017

Function Description
table FindUnitsInRadius(int teamNumber, Vector position, handle cacheUnit, float radius, int teamFilter, int typeFilter, int flagFilter, int order, bool canGrowCache)
Finds the units in a given radius with the given flags. ( iTeamNumber, vPosition, hCacheUnit, flRadius, iTeamFilter, iTypeFilter, iFlagFilter, iOrder, bCanGrowCache )
- Example
-- Find all Dire units
direUnits = FindUnitsInRadius(DOTA_TEAM_BADGUYS,
Vector(0, 0, 0),
nil,
FIND_UNITS_EVERYWHERE,
DOTA_UNIT_TARGET_TEAM_FRIENDLY,
DOTA_UNIT_TARGET_ALL,
DOTA_UNIT_TARGET_FLAG_NONE,
FIND_ANY_ORDER,
false)
-- Make the found units move to (0, 0, 0)
for _,unit in pairs(direUnits) do
unit:MoveToPosition(Vector(0, 0, 0))
end
Parameters
Type | Name | Description |
---|---|---|
int | teamNumber | Your Unit's Team. Refer Here |
Vector | position | Point in dota 2 map about which you want to center your search. Use unit:GetAbsOrigin() to center it about a unit. |
handle | cacheUnit | No Description Set |
float | radius | The search radius. (FIND_UNITS_EVERYWHERE means the radius will cover the whole map. Refer to more Here) |
int | teamFilter | This will be with respect to team on the first parameter. Refer Here |
int | typeFilter | Types of units you want to include/exclude in search. Refer Here |
int | flagFilter | Include/Exclude units which if respectilely flagged. Refer Here |
int | order | No Description Set |
bool | canGrowCache | No Description Set |
Returns
A table containing the found units. If no units are found, FindUnitsInRadius
returns an empty table; it does not return nil
.