View source for SpawnMonster

= spawnMonster =
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;">
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">IMPROVED FROM UPDATE 0.1.2</div>
<div style="color:#111111; margin-top:0.25rem;">This function is available in earlier releases and has corrected or expanded behavior in G1R:MP 0.1.2 and later. The contract below describes the updated behavior.</div>
</div>

Creates a server-owned monster and replicates it to interested players.

== Syntax ==
<syntaxhighlight lang="lua">
string|false spawnMonster(string type, number x, number y, number z [, number yaw = 0] [, table options])
</syntaxhighlight>

== Parameters ==
{| class="wikitable"
! Name !! Type !! Required !! Description
|-
| <code>type</code> || <code>string</code> || yes || A stable type key from [[Monster type catalog]].
|-
| <code>x</code> || <code>number</code> || yes || World X coordinate in metres.
|-
| <code>y</code> || <code>number</code> || yes || World Y coordinate in metres.
|-
| <code>z</code> || <code>number</code> || yes || World Z coordinate in metres.
|-
| <code>yaw</code> || <code>number</code> || no || Initial yaw in degrees.
|-
| <code>options</code> || <code>table</code> || no || Optional table. Set <code>aggressive</code> to false to create a passive monster. Set <code>navigationCollisionMode</code> to <code>"combined"</code>, <code>"builtin"</code>, or <code>"custom"</code>; the default is <code>"combined"</code>.
|}

== Returns ==
Returns the new opaque monster identifier string, or <code>false</code> when validation or spawning fails.

== Examples ==
Spawn a passive scavenger:
<syntaxhighlight lang="lua" line>
local monsterId = spawnMonster("scavenger", 15.0, -4.5, 2.0, 90, {
    aggressive = false,
    navigationCollisionMode = "combined",
})
if monsterId then
    outputDebugString("Spawned monster " .. monsterId)
end
</syntaxhighlight>

== Notes ==
* Available only in server-side resource scripts.
* The server owns identity, AI state, targeting, health, damage, relevance, and late-join replication.
* The selected navigation collision mode is applied to initial placement. Pass it during spawn when replacing a known baked false positive with custom blockers.
* Spawning an unsupported type or exceeding the server monster limit returns false.
* See [[Monster type catalog]] for every currently supported type key.

[[Category:Lua Functions]]
[[Category:Server Functions]]
[[Category:World Functions]]
[[Category:Monster Functions]]