Qrow: 1 revision imported

2025-11-14T05:21:28Z

1 revision imported

← Older revision	Revision as of 22:21, 13 November 2025
(No difference)

Interwiki>Kloot: Reverted edits by 8611 (talk) to last revision by Flozi

2015-02-01T13:53:32Z

Reverted edits by 8611 (talk) to last revision by Flozi

New page

= CEG Calls =
== Overview ==
There are four places where you can call a CEG: weapons, COB or LUS unit scripts, flying piece projectiles and synced Lua gadgets.

== Weapon CEGs ==

There are three weapon tags that can spawn CEGs:

*{{xtaglink|Gamedev:WeaponDefs|cegTag}} - Spawns the CEG every frame at the weapon projectile's position and direction.
*{{xtaglink|Gamedev:WeaponDefs|explosionGenerator}} - Spawns the CEG when the weapon hits its target.
*{{xtaglink|Gamedev:WeaponDefs|bounceExplosionGenerator}} - For bouncing weapons only. Spawns the CEG when the weapon bounces.

== Calling CEGs from unit scripts ==

Calling a CEG from unit scripts requires two steps. First, in the unit's definition, you need to '''define the order of the effects:'''

For a .fbi unitdef use:
<code><pre>
[sfxtypes] {
explosiongenerator0 = custom:ExplosionGeneratorName0;
explosiongenerator1 = custom:ExplosionGeneratorName1;
//and so on...
}
</pre></code>

For a .lua unitdef use:

<code><pre>
sfxtypes = {
explosiongenerators = {
"custom:ExplosionGeneratorName0",
"custom:ExplosionGeneratorName1",
--and so on...
},
},
</pre></code>
(See [[Gamedev:UnitDefs#SFXTypes]])

=== COB ===
To actually generate the explosion in a COB, you need to call [[Animation-CobConstants#emit-sfx|emit-sfx]]:

<code><pre>emit-sfx 1024 + ceg_num from pieceName;</pre></code>

Where ceg_num is the number of the explosion generator in the unit definition (the first one is 0, the next is 1, and so on). The CEG will have the position and direction of the piece you emit it from. For syntactic sugar you can use:

<code><pre>#define MY_FIRST_AWESOME_CEG 1024 + 0
emit-sfx MY_FIRST_AWESOME_CEG from pieceName;</pre></code>

In a COB script, you can call:

<code><pre>set CEG_DAMAGE damage_value</pre></code>

Any <code>emit-sfx</code> instructions will then use that value for the "damage" (use the '[[CEG:Operators#Damage_.28.27d.27.29|'d' operator]] to access this value).

=== LUS ===
In a Lua unit script you generate the explosion using [[Animation-LuaCallouts#Effects|Spring.UnitScript.EmitSfx]] e.g.:

<code><pre>EmitSfx(pieceName, SFX.CEG + ceg_num)</pre></code>

Where ceg_num is the number of the explosion generator in the unit definition as before.

== Piece Projectiles ==
CEGs can be attached to piece projectiles which are created when a unit script calls [[Animation-CobConstants#explode|explode]] (COB) or [[Animation-LuaCallouts#Effects|Explode]] (lua) with an argument of <code>COB.FALL</code>. See [[Gamedev:UnitDefs#pieceExplosionGenerators]].

== Synced Lua Gadget CEGs ==
The only method that lets you directly call a CEG by name, anywhere on the map.
See [[Lua_SyncedCtrl#Other|Spring.SpawnCEG]]. Note that the damage parameter does not apply damage, but is used to set the [[CEG:Operators#Damage_.28.27d.27.29|'d' operator]].

[[Category:CEG]]

CEG:Calls - Revision history

Qrow: 1 revision imported

Interwiki>Kloot: Reverted edits by 8611 (talk) to last revision by Flozi