Signature
KillFX(<localClientNum>, <effect id>)
Parameters
| Name | Required? | Details |
|---|---|---|
| localClientNum | Required | The local client the effect is playing on. |
| effect id | Required | The effect id returned by playFx |
Example (from Treyarch's docs)
KillFX ( fxId )
Real uses in BO3's scripts
Called 25 times in the decompiled scripts. A few, zombies first:
- scripts/zm/_zm_weap_raygun_mark3.csc, line 161
killfx(n_local_client, self.fx_slow_vortex); - scripts/zm/bgbs/_zm_bgb_mind_blown.csc, line 75
killfx(localclientnum, self.var_f40a5f31); - scripts/zm/zm_cosmodrome.csc, line 1033
killfx(localclientnum, self.var_a13e8509); - scripts/zm/zm_genesis_shadowman.csc, line 96
killfx(localclientnum, self.var_b0063e15); - scripts/zm/zm_genesis_util.csc, line 394
killfx(localclientnum, self.var_1ac96e93);
Related built-ins
- StopFX()Stops a given fx.
- DeleteFX()Delete a spawned effect.
- SetUkkoScriptIndex()Set ukko index from script.
- SetFilterPassConstant()Sets the filter pass constant
- SetFXIgnorePause()Tells an effect whether or not to respect a paused world state.
- SetFilterPassEnabled()Sets the filter pass enabled or disabled
- PlayViewmodelFX()
- SetFilterPassMaterial()Sets the filter pass material
- SetLitFogBank()Sets which bank to use for all lit fog volumes with matching script id
- SetPBGActiveBank()Set PBG bank mask from script.
- SetFXTeam()Set the team of the fx either by team or by entity which has a team set.
- PlayMainCamXCam()Plays an XCam on the main camera associated with the player starting at the current client time
New to GSC?
Start with the basics, or paste a compile error to get the fix.
Built-in descriptions, parameters and examples come from Treyarch's BO3 mod tools docs. Usage links point at shiversoftdev/t7-source (decompiled BO3 scripts).