166 MMX at 20:04, 2 December 2009

2009-12-02T20:04:26Z

← Older revision		Revision as of 20:04, 2 December 2009
Line 1:		Line 1:
	{{HarvestMethod		{{HarvestMethod
	\|		\|
-	~~getNumBuildings~~()	+	findAliens()
	\|		\|
-	Finds all ~~buildings~~.	+	Finds all aliens.
	\|		\|
	\|		\|
-	Returns an array of all ~~buildings~~.	+	Returns an array of all aliens.
	}}		}}

	{{HarvestMethod		{{HarvestMethod
	\|		\|
-	~~getNumBuildings~~(type)	+	findAliens(type)
	\|		\|
-	Finds all ~~buildings~~ of a certain type, such as ~~"SPARKPRODUCER" (Solar Plants)~~.	+	Finds all aliens of a certain type, such as ALIEN_DEFAULT.
	\|		\|
	{{MethodParam\|type\|String\|The building identifier name used for selection.}}		{{MethodParam\|type\|String\|The building identifier name used for selection.}}
	\|		\|
-	Returns an array of all ~~buildings~~ of a cretin identifier name.	+	Returns an array of all aliens of a cretin identifier name.
	}}		}}

	{{HarvestMethod		{{HarvestMethod
	\|		\|
-	~~getNumBuildings~~(x, y, radius)	+	findAliens(x, y, radius)
	\|		\|
-	Finds all ~~buildings~~ in a circle.	+	Finds all aliens in a circle.
	\|		\|
	{{MethodParam\|x\|Number\|The x coordinate of a point on the world map.}}		{{MethodParam\|x\|Number\|The x coordinate of a point on the world map.}}
Line 30:		Line 30:
	{{MethodParam\|radius\|Number\|The radius to be used.}}		{{MethodParam\|radius\|Number\|The radius to be used.}}
	\|		\|
-	Returns an array of all ~~buildings~~ in an certain radius.	+	Returns an array of all aliens in an certain radius.
	}}		}}

	{{HarvestMethod		{{HarvestMethod
	\|		\|
-	~~getNumBuildings~~(x, y, radius, type)	+	findAliens(x, y, radius, type)
	\|		\|
-	Finds all ~~buildings~~ of a certain type in a circle.	+	Finds all aliens of a certain type in a circle.
	\|		\|
	{{MethodParam\|x\|Number\|The x coordinate of a point on the world map.}}		{{MethodParam\|x\|Number\|The x coordinate of a point on the world map.}}
Line 44:		Line 44:
	{{MethodParam\|type\|String\|The building identifier name used for selection.}}		{{MethodParam\|type\|String\|The building identifier name used for selection.}}
	\|		\|
-	Returns an array of all ~~buildings~~ in an certain radius with a certain type.	+	Returns an array of all aliens in an certain radius with a certain type.
	}}		}}

	{{HarvestMethod		{{HarvestMethod
	\|		\|
-	~~getNumBuildings~~(left, top, right, bottom, type)	+	findAliens(left, top, right, bottom, type)
	\|		\|
-	Finds all ~~buildings~~ of a certain type in a rectangle.	+	Finds all aliens of a certain type in a rectangle.
	\|		\|
	{{MethodParam\|left\|Number\|The left coordinate of the rectangle.}}		{{MethodParam\|left\|Number\|The left coordinate of the rectangle.}}
Line 59:		Line 59:
	{{MethodParam\|type\|String\|The building identifier name used for selection.}}		{{MethodParam\|type\|String\|The building identifier name used for selection.}}
	\|		\|
-	Returns an array of all ~~buildings~~ in an certain rectangle with a certain type.	+	Returns an array of all aliens in an certain rectangle with a certain type.
	}}		}}

	=== Description ===		=== Description ===
-	~~All~~ of the functions above will return an array (which can be empty) ~~of buildings~~. The ~~buildings~~ will be of ~~user data~~ lua type, and refer to a ~~CBuildingLuaInfo~~ in Harvest's C++ code. On these objects you can perform getPosition(), getId() and various other functions (see separate thread soon). However, you may not keep a reference to these objects since it's not possible to predict when ~~a building is destroyed~~. Instead, if you need to keep track of a specific ~~building~~, you will have to save it's ID number and then locate it each frame with harvest.~~getBuilding~~(id).	+	Like with buildings, all of the functions above will return an array (which can be empty). The aliens will be of userdata lua type, and refer to a CAlienLuaInfo in Harvest's C++ code. On these objects you can perform getPosition(), getId() and various other functions (see separate thread soon). However, you may not keep a reference to these objects since it's not possible to predict when an alien has been removed. Instead, if you need to keep track of a specific alien, you will have to save it's ID number and then locate it each frame with harvest.getAlien(id).

	=== Example ===		=== Example ===
	<pre>		<pre>
-	-- ~~destroy~~ all ~~buildings in the circle!~~	+	-- randomly displace all aliens
-	~~buildings~~ = harvest.~~findBuildings~~(x, y, ~~200~~)	+	aliens = harvest.findAliens()
-	for i=1,#~~buildings~~ do	+	local left,top,right,bottom = harvest.getWorldBorders()
-	~~local x,y = buildings~~[i]:~~getPosition~~()	+	local width, height = right - left, bottom - top
-	~~harvest~~.~~spawnParticle(buildings[i]:getDeathParticle~~(), ~~x, y~~)	+	for i=1,#aliens do
-	~~buildings[i]:remove(~~)	+	aliens[i]:setPosition(left + math.random() * width, top + math.random() * height)
	end		end
	</pre>		</pre>

166 MMX: Created page with '{{HarvestMethod | getNumBuildings() | Finds all buildings. | | Returns an array of all buildings. }} {{HarvestMethod | getNumBuildings(type) | Finds all buildings of a certain t...'

2009-12-02T20:01:21Z

Created page with '{{HarvestMethod | getNumBuildings() | Finds all buildings. | | Returns an array of all buildings. }} {{HarvestMethod | getNumBuildings(type) | Finds all buildings of a certain t...'

New page

{{HarvestMethod
|
getNumBuildings()
|
Finds all buildings.
|
|
Returns an array of all buildings.
}}

{{HarvestMethod
|
getNumBuildings(type)
|
Finds all buildings of a certain type, such as "SPARKPRODUCER" (Solar Plants).
|
{{MethodParam|type|String|The building identifier name used for selection.}}
|
Returns an array of all buildings of a cretin identifier name.
}}

{{HarvestMethod
|
getNumBuildings(x, y, radius)
|
Finds all buildings in a circle.
|
{{MethodParam|x|Number|The x coordinate of a point on the world map.}}
{{MethodParam|y|Number|The y coordinate of a point on the world map.}}
{{MethodParam|radius|Number|The radius to be used.}}
|
Returns an array of all buildings in an certain radius.
}}

{{HarvestMethod
|
getNumBuildings(x, y, radius, type)
|
Finds all buildings of a certain type in a circle.
|
{{MethodParam|x|Number|The x coordinate of a point on the world map.}}
{{MethodParam|y|Number|The y coordinate of a point on the world map.}}
{{MethodParam|radius|Number|The radius to be used.}}
{{MethodParam|type|String|The building identifier name used for selection.}}
|
Returns an array of all buildings in an certain radius with a certain type.
}}

{{HarvestMethod
|
getNumBuildings(left, top, right, bottom, type)
|
Finds all buildings of a certain type in a rectangle.
|
{{MethodParam|left|Number|The left coordinate of the rectangle.}}
{{MethodParam|top|Number|The top coordinate of the rectangle.}}
{{MethodParam|right|Number|The right coordinate of the rectangle.}}
{{MethodParam|bottom|Number|The bottom coordinate of the rectangle.}}
{{MethodParam|type|String|The building identifier name used for selection.}}
|
Returns an array of all buildings in an certain rectangle with a certain type.
}}

=== Description ===
All of the functions above will return an array (which can be empty) of buildings. The buildings will be of user data lua type, and refer to a CBuildingLuaInfo in Harvest's C++ code. On these objects you can perform getPosition(), getId() and various other functions (see separate thread soon). However, you may not keep a reference to these objects since it's not possible to predict when a building is destroyed. Instead, if you need to keep track of a specific building, you will have to save it's ID number and then locate it each frame with harvest.getBuilding(id).

=== Example ===
<pre>
-- destroy all buildings in the circle!
buildings = harvest.findBuildings(x, y, 200)
for i=1,#buildings do
local x,y = buildings[i]:getPosition()
harvest.spawnParticle(buildings[i]:getDeathParticle(), x, y)
buildings[i]:remove()
end
</pre>

=== Resources ===
*[http://www.oxeyegames.com/forum/viewtopic.php?p=1523#p1523 Oxeye Game Studio Forum - Harvest Functions]

FindAliens (Harvest) - Revision history

166 MMX at 20:04, 2 December 2009

166 MMX: Created page with '{{HarvestMethod | getNumBuildings() | Finds all buildings. | | Returns an array of all buildings. }} {{HarvestMethod | getNumBuildings(type) | Finds all buildings of a certain t...'