Effect components
EntSlotComponent and EntEffectSpawnerComponent
Summary
This page will tell you how effect components work and how they interact with each other.
Wait, that's not what I want!
For an overview on existing effect materials, check FX Material Properties
For a guide on how to use effects, check AMM: Light Components
Effect component types
You will see two kinds of effect component types, which always occur in pairs.
entSlotComponent
Usually called fx_slots
, this component allows you to place your effects in the world. It requires the definitions in the entEffectSpawnerComponent to work.
![](https://wiki.redmodding.org/~gitbook/image?url=https%3A%2F%2F1427525421-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F4gzcGtLrr90pVjAWVdTc%252Fuploads%252F9DsDrO2Esf8nsnQS5TNo%252FentSlotComponent.png%3Falt%3Dmedia%26token%3D020826dd-1412-4422-a4e4-1576a6071978&width=768&dpr=4&quality=100&sign=19195045&sv=1)
If you want the position of your effects to follow the movement of parts of the object you can set the boneName
an existing bone of your object
![](https://wiki.redmodding.org/~gitbook/image?url=https%3A%2F%2F1427525421-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F4gzcGtLrr90pVjAWVdTc%252Fuploads%252FaBP5klNjy04iwOTqaK3w%252Fimage.png%3Falt%3Dmedia%26token%3Db4453af6-37dd-4507-b6bd-f0dc1203c713&width=768&dpr=4&quality=100&sign=a7fb6af0&sv=1)
In this case the relativePosition
will be relative to the bone's position
entEffectSpawnerComponent
Usually called fx_whateverTheEffectIs
, this component defines and registers effects which can then be placed via slots.
![](https://wiki.redmodding.org/~gitbook/image?url=https%3A%2F%2F1427525421-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F4gzcGtLrr90pVjAWVdTc%252Fuploads%252FN8s3IzBbE36Z2UmcBcl1%252FentEffectSpawnerComponent.png%3Falt%3Dmedia%26token%3D20b511fa-1e55-4eed-beb3-9813f3cc4fd2&width=768&dpr=4&quality=100&sign=a801e9fe&sv=1)
Adding and deleting effect slots
Deletions
In the entEffectSpawnerComponent
, delete:
the
placementTag
entry that you want to get rid ofthe corresponding entry in
placementInfos
(see the yellow arrows on the screenshot under entEffectSpawnerComponent)
In the entSlotComponent
, delete:
The entry in
slots
referencing the previously deleted component by name.
Additions
In the entEffectSpawnerComponent
, add:
a new
placementTag
at the end of the array with the name of your new entry (e.g.fx_candle_slot_04
)a new entry under
placementInfos
(by duplicating the last entry), setting theplacementTagIndex
to the numeric index of theplacementTag
you created in step 1
In the entSlotComponent
, add:
a new entry in
slots
with the name that you created in Step 1
autoSpawnTag
If you are making effects into equipment, having the same autoSpawnTag will make it so equipping one will despawn the other one.
eventRUID
eventRUID in the ent component must be the same as the effect particles ruid, and ideally should be unique across everything. You can right click on a RUID field and choose "Generate new CRUID" to generate a semi-random new CRUID and then copy it across so they match.
![](https://wiki.redmodding.org/~gitbook/image?url=https%3A%2F%2F1427525421-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F4gzcGtLrr90pVjAWVdTc%252Fuploads%252FjldQgjmAgCerJrob0KJM%252Fimage.png%3Falt%3Dmedia%26token%3Dcdb31f2b-000e-446e-90da-0349b8b99349&width=768&dpr=4&quality=100&sign=9cfbac19&sv=1)
Placing effect components
Please check AMM: Light Components -> Placing your light components for a detailed guide!
Last updated