CEG:Calls - Revision history

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

← Older revision		Revision as of 14:53, 1 February 2015
Line 7:		Line 7:
	There are three weapon tags that can spawn CEGs:		There are three weapon tags that can spawn CEGs:

	*{{xtaglink\|Gamedev:WeaponDefs\|cegTag}} - Spawns the CEG every ~~0.1 seconds~~ at the weapon projectile's position and direction.		*{{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\|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.		*{{xtaglink\|Gamedev:WeaponDefs\|bounceExplosionGenerator}} - For bouncing weapons only. Spawns the CEG when the weapon bounces.

8611: /* Weapon CEGs */ cegTag every 0.1 seconds

2015-02-01T09:13:28Z

Weapon CEGs: cegTag every 0.1 seconds

← Older revision		Revision as of 10:13, 1 February 2015
Line 7:		Line 7:
	There are three weapon tags that can spawn 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\|cegTag}} - Spawns the CEG every 0.1 seconds at the weapon projectile's position and direction.
	*{{xtaglink\|Gamedev:WeaponDefs\|explosionGenerator}} - Spawns the CEG when the weapon hits its target.		*{{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.		*{{xtaglink\|Gamedev:WeaponDefs\|bounceExplosionGenerator}} - For bouncing weapons only. Spawns the CEG when the weapon bounces.

Flozi: Flozi moved page CEG-Calls to CEG:Calls: Consistency

2014-10-05T18:38:38Z

Flozi moved page CEG-Calls to CEG:Calls: Consistency

← Older revision	Revision as of 19:38, 5 October 2014
(No difference)

Flozi: bulk out and tidy up formatting

2014-10-05T18:38:02Z

bulk out and tidy up formatting

← Older revision		Revision as of 19:38, 5 October 2014
Line 1:		Line 1:
			= CEG Calls =
	== Overview ==		== Overview ==
	There are four places where you can call a CEG: weapons, COB unit scripts, ~~Lua unit scripts,~~ synced ~~part of~~ Lua gadgets.		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 ==		== Weapon CEGs ==
Line 6:		Line 7:
	There are three weapon tags that can spawn CEGs:		There are three weapon tags that can spawn CEGs:

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

	~~You need to set these tags equal to custom:ExplosionGeneratorName. For example, in a .tdf,~~		== Calling CEGs from unit scripts ==
	~~<code><pre>explosionGenerator=custom:ExplosionGeneratorName;</pre></code>~~

	==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:'''		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:		For a .fbi unitdef use:
	<code><pre>		<code><pre>
	[sfxtypes] {		[sfxtypes] {
Line 26:		Line 24:
	</pre></code>		</pre></code>

	~~for~~ a .lua unitdef use:		For a .lua unitdef use:

	<code><pre>		<code><pre>
Line 37:		Line 35:
	},		},
	</pre></code>		</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).

	~~'''To actually~~ generate the explosion ~~in a COB''', you need to <code>emit~~-~~sfx</code> 1024 plus 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~~.		=== LUS ===
			In a Lua unit script you generate the explosion using [[Animation-LuaCallouts#Effects\|Spring.UnitScript.EmitSfx]] e.g.:

	~~There is another tag,~~ <code>~~[[pieceTrailCEGTag]]~~<~~/code~~>, ~~which is used in~~ <~~code~~>~~explode [piece] FALL;~~</code> ~~to spawn CEG trails behind falling pieces.~~		<code><pre>EmitSfx(pieceName, SFX.CEG + ceg_num)</pre></code>

	~~'''CEG_DAMAGE:''' In a COB script, you can do <code>SET CEG_DAMAGE [value]</code>. Any <code>emit-sfx</code> instructions will then use that value for~~ the ~~"damage" (use~~ the ~~'d' operator to access this value)~~.		Where ceg_num is the number of the explosion generator in the unit definition as before.

	~~'''In~~ a ~~Lua~~ unit script ~~you generate the explosion like this:'''~~		== Piece Projectiles ==
	[~~http://springrts.com/wiki/~~Animation-LuaCallouts#Effects ~~have a look at the CallOuts~~ of ~~unit scripts~~]		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]].

	~~== Lua CEGs ==~~
	~~See Spring.SpawnCEG in [[Lua_SyncedCtrl]].~~
	[[Category:CEG]]		[[Category:CEG]]

Knorke at 03:07, 10 April 2011

2011-04-10T03:07:32Z

← Older revision		Revision as of 04:07, 10 April 2011
Line 1:		Line 1:
	== Overview ==		== Overview ==
	There are ~~three~~ places where you can call a CEG: weapons, COB, ~~and~~ Lua.		There are four places where you can call a CEG: weapons, COB unit scripts, Lua unit scripts, synced part of Lua gadgets.

	== Weapon CEGs ==		== Weapon CEGs ==
Line 13:		Line 13:
	<code><pre>explosionGenerator=custom:ExplosionGeneratorName;</pre></code>		<code><pre>explosionGenerator=custom:ExplosionGeneratorName;</pre></code>

	== ~~COB~~ CEGs ==		==Calling CEGs from unit scripts ==

	Calling a CEG from ~~COB~~ requires two steps. First, in the unit's definition, you need to ~~put~~		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>		<code><pre>
	[sfxtypes] {		[sfxtypes] {
Line 25:		Line 26:
	</pre></code>		</pre></code>

	for a .~~fbi, or~~		for a .lua unitdef use:

	<code><pre>		<code><pre>
Line 37:		Line 38:
	</pre></code>		</pre></code>

	To actually generate the explosion, you need to <code>emit-sfx</code> 1024 plus 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.		'''To actually generate the explosion in a COB''', you need to <code>emit-sfx</code> 1024 plus 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.

	There is another tag, <code>[[pieceTrailCEGTag]]</code>, which is used in <code>explode [piece] FALL;</code> to spawn CEG trails behind falling pieces.		There is another tag, <code>[[pieceTrailCEGTag]]</code>, which is used in <code>explode [piece] FALL;</code> to spawn CEG trails behind falling pieces.

	'''CEG_DAMAGE:''' In a COB script, you can do <code>SET CEG_DAMAGE [value]</code>. Any <code>emit-sfx</code> instructions will then use that value for the "damage" (use the 'd' operator to access this value).		'''CEG_DAMAGE:''' In a COB script, you can do <code>SET CEG_DAMAGE [value]</code>. Any <code>emit-sfx</code> instructions will then use that value for the "damage" (use the 'd' operator to access this value).

			'''In a Lua unit script you generate the explosion like this:'''
			[http://springrts.com/wiki/Animation-LuaCallouts#Effects have a look at the CallOuts of unit scripts]


	== Lua CEGs ==		== Lua CEGs ==
	See [[Lua_SyncedCtrl]].		See Spring.SpawnCEG in [[Lua_SyncedCtrl]].
	[[Category:CEG]]		[[Category:CEG]]

Abma at 20:13, 24 February 2011

2011-02-24T20:13:11Z

← Older revision		Revision as of 21:13, 24 February 2011
Line 1:		Line 1:
	~~{{delete}}~~

	== Overview ==		== Overview ==
	There are three places where you can call a CEG: weapons, COB, and Lua.		There are three places where you can call a CEG: weapons, COB, and Lua.

Abma at 20:13, 24 February 2011

2011-02-24T20:13:03Z

← Older revision		Revision as of 21:13, 24 February 2011
Line 1:		Line 1:
			{{delete}}

	== Overview ==		== Overview ==
	There are three places where you can call a CEG: weapons, COB, and Lua.		There are three places where you can call a CEG: weapons, COB, and Lua.

Jk: /* Weapon CEGs */

2010-07-01T03:19:48Z

Weapon CEGs

← Older revision		Revision as of 04:19, 1 July 2010
Line 11:		Line 11:

	You need to set these tags equal to custom:ExplosionGeneratorName. For example, in a .tdf,		You need to set these tags equal to custom:ExplosionGeneratorName. For example, in a .tdf,
	<code>explosionGenerator=custom:ExplosionGeneratorName;</code>		<code><pre>explosionGenerator=custom:ExplosionGeneratorName;</pre></code>

	== COB CEGs ==		== COB CEGs ==

Jk: /* COB CEGs */

2010-07-01T03:19:31Z

COB CEGs

← Older revision		Revision as of 04:19, 1 July 2010
Line 17:		Line 17:
	Calling a CEG from COB requires two steps. First, in the unit's definition, you need to put		Calling a CEG from COB requires two steps. First, in the unit's definition, you need to put

	<code>		<code><pre>
	[sfxtypes] {		[sfxtypes] {
	explosiongenerator0 = custom:ExplosionGeneratorName0;		explosiongenerator0 = custom:ExplosionGeneratorName0;
Line 23:		Line 23:
	//and so on...		//and so on...
	}		}
	</code>		</pre></code>

	for a .fbi, or		for a .fbi, or

	<code>		<code><pre>
	sfxtypes = {		sfxtypes = {
	explosiongenerators = {		explosiongenerators = {
Line 35:		Line 35:
	},		},
	},		},
	</code>		</pre></code>

	To actually generate the explosion, you need to <code>emit-sfx</code> 1024 plus 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.		To actually generate the explosion, you need to <code>emit-sfx</code> 1024 plus 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.

Koshi: fix category

2010-03-13T17:40:02Z

fix category

← Older revision		Revision as of 18:40, 13 March 2010
Line 45:		Line 45:
	== Lua CEGs ==		== Lua CEGs ==
	See [[Lua_SyncedCtrl]].		See [[Lua_SyncedCtrl]].
			[[Category:CEG]]