Types/FootstepTriggerEffectList

From Official Factorio Wiki
Revision as of 17:51, 16 August 2023 by BilkaBot (talk | contribs) (Protected "Types/FootstepTriggerEffectList": Migrated prototype doc to separate website ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
Jump to navigation Jump to search

The prototype docs have moved to a new website with an improved format. This documentation page can now be found here: https://lua-api.factorio.com/latest/types/FootstepTriggerEffectList.html

This wiki page is no longer updated and will be removed at some point in the future, so please update your browser bookmarks or other links that sent you here. If you'd like to contribute to the new docs, you can leave your feedback on the forums.


Array of CreateParticleTriggerEffectItem. Each CreateParticleTriggerEffectItem needs the extra mandatory property tiles, which is a table (array) of string which is the name of a tile.
Alternatively, instead of specifying the CreateParticleTriggerEffectItem directly in the table with the tiles property, a actions property that is an array of CreateParticleTriggerEffectItem can be specified in the table with the tiles property.

Furthermore, the table with the tiles property can contain a use_as_default property which is a boolean value. use_as_default defaults to false. When it is set to true, the trigger(s) defined in that table are the default triggers for tiles that don't have an associated footstep particle trigger (don't show up in one of the "tiles" lists).

Examples

footstep_particle_triggers =
{
  {
    tiles = { "water", "water-shallow" },
    type = "create-particle",
    particle_name = "water-particle",
    ....
  },
  {
    tiles = { "grass-1", "grass-2" },
    type = "create-particle",
    particle_name = "grass-particle",
    ....
  },
  ....
}
footstep_particle_triggers =
{
  {
    tiles = { "water", "water-shallow" },
    actions = 
    {
      {
        type = "create-particle",
        particle_name = "water-particle-1",
        ....
      },
      {
        type = "create-particle",
        particle_name = "water-particle-2",
        ....
      },
      ....
    }
  },
  {
    tiles = { "grass-1", "grass-2" },
    actions = 
    {
      {
        type = "create-particle",
        particle_name = "grass-particle-1",
        ....
      },
      {
        type = "create-particle",
        particle_name = "grass-particle-2",
        ....
      },
      ....
    }
  },
}

Template:Prototype property type usage