BIS fnc spawnEnemy: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|Multiplayer Effects(...)
m (Remove 'broken' warning)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function
{{RV|type=function


| arma2oa
|game1= arma2oa
|version1= 1.50


|1.51|= Game version
|game2= tkoh
|version2= 1.00
 
|game3= arma3
|version3= 0.50


|gr1= Object Manipulation
|gr1= Object Manipulation


| Constantly spawns enemies around a player according to array of enemy classes. The units will try to hunt down the player.
|descr= Constantly spawns enemies around a player according to array of enemy classes. The units will try to hunt down the player.


| [aPlayer, target, side, classes, maxEnemies, delay, code] spawn [[BIS_fnc_spawnEnemy]]
|exec= spawn


|pr= This function displays an error every time (at least in {{arma3}}) as it uses an undefined variable (typo '''line 30''', {{Inline code|_players}} )
|s1= [aPlayer, target, side, classes, maxEnemies, delay, code] spawn [[BIS_fnc_spawnEnemy]]


|p1= aPlayer: [[Object]] - player
|p1= aPlayer: [[Object]] - a unit that [[isPlayer|is a player]]


|p2= target: [[Object]] - refence object (enemies will be spawned on same direction in respect to the player)
|p2= target: [[Object]] - reference object (enemies will be spawned on same direction in respect to the player)


|p3= side: [[Side]] - side of the spawned enemies
|p3= side: [[Side]] - side of the spawned enemies


|p4= classes: [[Array]] of [[String]] - list of enemy classes (units will form a group together)
|p4= classes: [[Array]] of [[String]]s - list of enemy classes (units will form a group together)
{{Feature|important|Classes must be of the defined ''side'', otherwise they will attack each other.}}


|p5= maxEnemies: [[Number]] - (Optional, default 10) maximum number of enemies at once
|p5= maxEnemies: [[Number]] - (Optional, default 10) maximum number of enemies at once
Line 25: Line 31:
|p6= delay: [[Number]] - (Optional, default 30) time between spawn waves
|p6= delay: [[Number]] - (Optional, default 30) time between spawn waves


|p7= code: [[Code]] - (Optional, default {}) - code to execute on each unit (referenced by [[_this]])
|p7= code: [[Code]] - (Optional, default {}) - code to execute on each unit (referenced by [[Magic Variables#this|_this]])


| [[Nothing]]
|r1= [[Nothing]]


|exec= spawn|x1= <code>[<nowiki/>[[player]], [[player]], [[opfor]], ["O_Soldier_F"]] [[spawn]] [[BIS_fnc_spawnEnemy]];</code>
|x1= <sqf>[player, player, opfor, ["O_Soldier_F"]] spawn BIS_fnc_spawnEnemy;</sqf>


| [[BIS_fnc_spawnGroup]], [[BIS_fnc_stalk]]
|seealso= [[BIS_fnc_spawnGroup]] [[BIS_fnc_stalk]]
}}
}}
[[Category:{{Name|tkoh}}: Functions|{{uc:spawnEnemy}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:spawnEnemy}}]]

Latest revision as of 00:19, 4 February 2023

Hover & click on the images for description

Description

Description:
Constantly spawns enemies around a player according to array of enemy classes. The units will try to hunt down the player.
Execution:
spawn
Groups:
Object Manipulation

Syntax

Syntax:
[aPlayer, target, side, classes, maxEnemies, delay, code] spawn BIS_fnc_spawnEnemy
Parameters:
aPlayer: Object - a unit that is a player
target: Object - reference object (enemies will be spawned on same direction in respect to the player)
side: Side - side of the spawned enemies
classes: Array of Strings - list of enemy classes (units will form a group together)
Classes must be of the defined side, otherwise they will attack each other.
maxEnemies: Number - (Optional, default 10) maximum number of enemies at once
delay: Number - (Optional, default 30) time between spawn waves
code: Code - (Optional, default {}) - code to execute on each unit (referenced by _this)
Return Value:
Nothing

Examples

Example 1:
[player, player, opfor, ["O_Soldier_F"]] spawn BIS_fnc_spawnEnemy;

Additional Information

See also:
BIS_fnc_spawnGroup BIS_fnc_stalk

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