feat(mods/teleportation_tech): Teleporter mod

[borsek]

Purpose of change

• fixes Expose player teleport function to lua #3164

With LUA modding added to CBN, I tried my hand at making a sensible teleporter mod. With this mod, a static base should be much more viable.

If possible with LUA, I intend to extend it to vehicles (stations and anchors as vehicle parts). I'd probably need some more hooks for that, but there could also be workarounds.

Describe the solution

The mod description is in main.lua. In short - the player places teleport stations and anchors (by using the respective items, which use LUA to place furniture). Everything else is done by using the 'teleporter remote' item.

Stations fill by 1 energy per hour, and can also be pumped with grid energy to get 'charge'. 1 charge allows teleporting for 1 overmap tile. The station charging is done locally (player and grid with power must be on the teleport station omt) with a teleport controller, allowing the player to convert 1000kj into 1 charge for a picked station.

Using a teleport controller, the player can teleport from anywhere (charge permitting) to a teleport anchor (placed furniture), using a station, provided the station has enough power,

The hourly charge and kj-to-charge variables are easily modified by the user in main.lua.

Describe alternatives you've considered

Play more Avorion instead of coding.

Testing

No major bugs. Some features I want still need to be implemented.

Screenshots

[borsek]

Oh, I'm totally open to any suggestions, code improvements, etc.

very noob coder, so any help is appreciated!

[Ali-Anomma]

Oh, I'm totally open to any suggestions, code improvements, etc.

very noob coder, so any help is appreciated!

what about ability of naming the waystations?

[scarf005]

Hi, could we get add a tasklist to check which feature is implemented and which feature needs to be worked on?

[borsek]

I haven't checked this for compatibility since my last update, but I needed #3164 done to finish up. Obviously the naming suggestion is not in as of yet, but I can get around to it at some point, if not otherwise, then as an update - I get it though, name teleport destinations as "lab" "home" etc.

[borsek]

Need the item spawning on ground/in player inventory functions added, otherwise should work if scarf merges his lua update, at least the teleportation will, that is.

[scarf005]

2023-12-04_09-16-44.mp4

sorry for the long delay. while our Lua infrastructure has much to desire, the mod work alright, and this would be the stepping stone for better Lua support.

thank you for the hard work.

[borsek]

<3 thank you for the update, I've been mostly away for a while now, I'll get the itch again and update this in the future - v.1.1 with vehicle stations and better deconstruction ;)

Thanks for your work on it!

[scarf005]

future planned issue:

• add Lua formatter
• format all Lua files
• document Lua style guide