New Event: on_entity_teleported, script_raised_teleported

[eradicator]

What

Official support for event based teleportation handling between mods.

Details

Several mods like Picker Dollies or Warptorio 2 allow the player to teleport/move existing entities. However due to lack of an "official" event for this everyone implements their own undocumented remote interface for sharing event ids which makes it difficult for other mod authors to support "moving" as a generic function.

Expected

Ideally it would be awesome if LuaEntity.teleport() also supported "{raise_teleported=true}" style equivalent to LuaSurface.create_entity. The event could look something like this:

Code: Select all

on_entity_teleported or script_raised_teleported

  Called after an entity was teleported.

  Contains
    entity :: LuaEntity
    source_position :: Position
    source_surface :: LuaSurface
    player_index :: uint (optional): The player that caused the teleporting.
    

[Optera]

+1
Having to register to custom events on each mod teleporting entities around became a loosing battle.

[ILLISIS]

+1 from me

Space Exploration's upcoming version will teleport spiders to other surfaces instead of cloning them so having a natural event-driven way to detect a surface change of a spider will be useful.

[Stringweasel]

+1

Would be great to ensure your custom entities don't break without you knowing. For example with SE's spaceships and my Space Spidertron

[Xorimuth]

+1
Picker dollies and Space Exploration both use teleportation and are both very common. It would be nice not to have to rely on implementing custom events, etc.

[Pi-C]

+1! GCKI may teleport vehicles to another surface. If a vehicle controlled by AAI Programmable Vehicles is teleported to another surface, it will resume its path there -- even if that doesn't make sense. While I have a custom event that I can raise (or so I believe), it would be more transparent for other mods if they could listen to a vanilla event instead of having to ask me for the latest event ID.

[Stringweasel]

This is implemented 1.1.77. Awesome!