Teleport Sims Interactions

Note: See "Changelog" at the bottom of this description if you want to know why this was updated.
Why use this over another mod to teleport sims?

• Ease of access (Just three clicks away if testing cheats are enabled)
• Teleporting up to 25 sims at once with object-footprint-aware position dispersal (See images)
• A warning so you don’t accidentally remove a sim from a rabbit hole (See images)
• One simple interaction to send all teleported sims back home and another one if you want to send individual sims home

Showcase


Installation

• In the game’s settings make sure that under "Other" the options of "Enable Custom Content and Mods" and "Script Mods Allowed" are both enabled
• Extract the .package and .ts4script files to your Mods folder or a subfolder of the Mods folder.

Note: The .ts4script file can be at most only one subfolder deep, as The Sims 4 doesn’t load script files if they are deeper than that.

Recommended Mods
While not required, you should probably install Twisted Mexi's "Searchable Sims Picker" (Do check if it has been updates since the last patch, UI mods break quite often). You can find the link to it over at his website.

Usage
Teleporting
When shift-clicking the ground when testing cheats are enabled, you will find the "Teleport Sims..." category, under which you will further find the following interactions.

"From Vicinity", "From Played Households" and "From Everywhere" -
Use any of these interactions and you can then select up to 25 sims which will usually be dispersed in a 5x5 rectangle from where you originally clicked, as long as the game can calculate appropriate positions, otherwise the sims may overlap (not enough positions found for the number of sims) or just be teleported to where you clicked (if no appropriate positions are found).

"Previously Teleported"
Use this to teleport the last batch of teleported sims to a new location.

Settings
Under the "Teleport Sims..." category you will also find two options that show depending on if you clicked on the ground/a rug or on normal object/sim.

"Disperse on Ground" and "Disperse on Object/Sim"
These show if the dispersal/spreading out of sims is enabled when teleporting. Their icons indicates if the setting is turned on or off. Click once to switch the setting. Disabling disperse on object/sim can, depending on the object, still results in one or all sims being placed at the object's location currently.

Sending Home
You have two interactions for also sending sims home:

Force all teleported Sims to go home
Available under the normal teleporting category when clicking on a sim, but only if there is single teleported sim that hasn’t been send home left. Runs the next described interaction on all teleported sims.

Force to go home
Available under the normal teleporting category when clicking on any sim. Normally injects the sim into the home or vacation home zone. If we are however on this zone, the sim will be teleported to what the game considers the "default position" for the home. This is usually just somewhat behind the front door.
In the case that you are on a foreign lot and send your only household sim home you will have to have to Save and go to Manage Worlds to continue playing.

Notes / Known issues
Teleporting special sims
You may want to restrain yourself from teleporting special sims, especially when an event related to them occurs, or at least only really use it when needed. As teleporting them may mess up their roles/situations and also generally resets them like the "Reset Object (Debug)" interaction available.
Let's take Grim for example in the event that a sim dies. In my testing, it seems to mess up Grim's reaper role when you teleport him after the sim has already died. The game does however have a fail-safe for when Grim doesn't reach the corpse after some time, so the sim will still be turned into an urn/ghost, you just can't plead for that sim if Grim isn't in his reaper role.

Known issues with the position dispersal
Generally, you will not have much problems with it, there are a few cases where you will run into issues.

• The area of an unloaded lot in a zone for whatever reason cause the game to mess up the height calculation and as such we can’t calculate appropriate positions for teleportation. You can teleport near the borders of unloaded lots, just don’t teleport too far into them.
• Teleporting near walls that don't form another room to the one you want to teleport to or walls that are diagonal can cause problems.

Credits
Localization/Translation
ChatGPT (If you think something would sound better if written differently or if some text is wrong, just shoot me a message. Though please also explain why.)

Changelog
1.1.1
Addresses an annoyance/problem (not a bug) with the teleport if you teleport a sim with the fairy wings equipped from the newest DLC. As the wings are considered an object that the sim "carries" (similar to the "Set as Head" Object cheat interaction), when the sim gets reset - which this mod does to stop the sim from whatever they are doing - the sim's fairy wings are unequipped. They normally only get requipped once a sim does something else.
This update partialy addressed this by ensuring that the first thing the sim does, if you have your game unpaused, is equip their wings again after a second without having to do something else. I'll mabye look into manually adding the equipping of the wings, so you won't even have to unpause, at a later date.

BTW, this update SHOULD be compatible with game versions before the newest DLC, if you still run into problems maybe try the update before this.

1.1.0
TL;DR: You can now enable/disable the dispersal/spreading out of sims, teleport the last batch of teleported sims more easily and also use the teleport interactions on objects.

Changes:

• When teleporting a sim that is currently posing with WW or Andrew's pose player then the sim will not be reset (Same as using the debug reset interaction on them)
• Added config options to disable & enable the dispersal, seperated by if used on the ground/rug or on other objects/sims, see added interactions. Currently, enabling dispersal on objects/sim can still result for some objects in either a single sim being placed in the location of the object, but it does disperse the other sims correctly, or all still being placed into the location of the object.

Added Interactions:

• "Previously teleported"
  Under "Teleport Sims...", teleports the previous batch of sims to the new location/object.
• "Dispersal on Ground?" & "Dispersal on Object/Sim?"
  These are also available under "Teleport Sims..." depending on if you clicked on the ground/rug or on another object/sim. Their icon shows if the setting is currently enabled or disabled. By default dispersal on ground is enabled and dispersal on object/sim is disabled.

1.0.1
Improves the object-awareness (E.g. rugs and other objects a sim can walk through/on top of now shouldn't be a problem.) and fixes sim being teleported to impassable terrain.