BIS fnc animalSiteSpawn: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
Lou Montana (talk | contribs) m (Text replacement - "[[Arma 3 " to "[[Arma 3: ") |
||
| (39 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{RV|type=function | |||
|game1= arma3 | |||
|version1= 1.00 | |||
| | |gr1= Ambient | ||
| | |serverExec= server | ||
| Create an area that spawns animals. The animals will be created or deleted if a player is inside or outside the area's radius. | |descr= Create an area that spawns animals. The animals will be created or deleted if a player is inside or outside the area's radius. | ||
| | |s1= [animalSite, classnamesToSpawn, radius] call [[BIS_fnc_animalSiteSpawn]] | ||
|p1 | |p1= animalSite: [[Object]] - the object to create the site around. | ||
| [[ | |p2= classnamesToSpawn: [[Array]] of [[String]]s - animals that can be spawned. | ||
| | |p3= radius: [[Number]] - the radius by which animals are created or deleted. | ||
| [[ | |r1= [[Script Handle]] | ||
|x1= <sqf>[player, ["rabbit_f", "turtle_f", "hen_random_f"], 200] call BIS_fnc_animalSiteSpawn;</sqf> | |||
|seealso= [[Arma 3: CfgVehicles Animals]] | |||
}} | }} | ||
{{Note | |||
|user= DreadedEntity | |||
|timestamp= 20141207083700 | |||
|text= The only way to stop the animals from spawning is to delete the object. When using this function, I recommend creating a non-solid object (almost anything from the "Objects (Helpers)" list in the editor, and using [[hideObjectGlobal]] on it. Using [[setVariable]] you can add the animal site to a reference object to find it easily when you want to delete it. | |||
<sqf> | |||
private _obj = createVehicle ["Sign_Sphere10cm_F", getPos player, [], 0, "CAN_COLLIDE"]; | |||
hideObjectGlobal _obj; | |||
player setVariable ["animalSite", _obj]; | |||
_obj = nil; | |||
</sqf> | |||
The only way to stop the animals from spawning is to delete the object. When using this function, I recommend creating a non-solid object (almost anything from the "Objects (Helpers)" list in the editor, and using [[hideObjectGlobal]] on it. Using [[setVariable]] you can add the animal site to a reference object to find it easily when you want to delete it. | |||
< | |||
player | |||
_obj = | |||
There are two hidden variables, "animalCount" and "radius". Use [[setVariable]] on the object to change these.<br> | There are two hidden variables, "animalCount" and "radius". Use [[setVariable]] on the object to change these.<br> | ||
| Line 56: | Line 41: | ||
Both are numbers.<br><br> | Both are numbers.<br><br> | ||
The "area" is imaginary. It is not a tangible area defined by trigger or marker radius, the area is only saved as an integer within the function. | The "area" is imaginary. It is not a tangible area defined by trigger or marker radius, the area is only saved as an integer within the function. | ||
}} | |||
{{Note | |||
|user= Strangepete | |||
|timestamp= 20141207092600 | |||
|text= Using the [[Script Handle]] returned, the function can be checked using [[scriptDone]] or killed with [[terminate]]; Existing generated animals will ''not'' be cleaned up when terminated. | |||
<sqf> | |||
Using the [[ | _handle = [params] call BIS_fnc_animalSiteSpawn; | ||
< | |||
if | if !(scriptDone _handle) then { | ||
terminate _handle; | |||
}; | }; | ||
</ | </sqf> | ||
}} | |||
Latest revision as of 10:38, 6 May 2024
Description
- Description:
- Create an area that spawns animals. The animals will be created or deleted if a player is inside or outside the area's radius.
- Execution:
- call
- Groups:
- Ambient
Syntax
- Syntax:
- [animalSite, classnamesToSpawn, radius] call BIS_fnc_animalSiteSpawn
- Parameters:
- animalSite: Object - the object to create the site around.
- classnamesToSpawn: Array of Strings - animals that can be spawned.
- radius: Number - the radius by which animals are created or deleted.
- Return Value:
- Script Handle
Examples
- Example 1:
Additional Information
- See also:
- Arma 3: CfgVehicles Animals
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
- Posted on Dec 07, 2014 - 08:37 (UTC)
-
The only way to stop the animals from spawning is to delete the object. When using this function, I recommend creating a non-solid object (almost anything from the "Objects (Helpers)" list in the editor, and using hideObjectGlobal on it. Using setVariable you can add the animal site to a reference object to find it easily when you want to delete it.
There are two hidden variables, "animalCount" and "radius". Use setVariable on the object to change these.private _obj = createVehicle ["Sign_Sphere10cm_F", getPos player, [], 0, "CAN_COLLIDE"]; hideObjectGlobal _obj; player setVariable ["animalSite", _obj]; _obj = nil;
animalCount is supposed to limit the amount of animals that can spawn. In the code, the algorithm for this is hard to understand.
radius refers to how far away from the object the animals can spawn.
Both are numbers.
The "area" is imaginary. It is not a tangible area defined by trigger or marker radius, the area is only saved as an integer within the function.
- Posted on Dec 07, 2014 - 09:26 (UTC)
- Using the Script Handle returned, the function can be checked using scriptDone or killed with terminate; Existing generated animals will not be cleaned up when terminated.