[DOC] Teleports - Technical Info

Trekkan

JFF Administrator
Staff member
All of this information is already contained within RAT Events and Groups, but is being posted here for clarity on what variables are used during teleports and for those that are into the more technical side of RAT.

RAT Script Command: .TELEPORT:<name>
Event Variables:​
tele_name, tele_coords​

Group Attributes:​
tele_must_wait_txt - sayplayer {player_steam} "Sorry but you must wait {tele_must_wait_time} minutes before you can teleport again."​
tele_teleport_txt - sayplayer {player_steam} "Teleporting you to {tele_name}"​
tele_teleport - teleportplayer {player_steam} {tele_coords}​
tele_max_destinations - 3​
tele_max_destinations_txt - sayplayer {player_steam} "Sorry, but you have used all of your destinations, please overwrite or delete an existing destination and try again."​
tele_saved_txt - sayplayer {player_steam} "Teleport saved. Name: {tele_name}, Coordinates: {tele_coords}"​
tele_wait_time - 60​


RAT Script Command: .LISTTELEPORTS
Event Variables:​
tele_name, tele_coords​
Group Attributes:​
tele_max_destinations​
tele_dests_list_header_txt - sayplayer {player_steam} "The following are your saved teleport locations:"​
tele_dests_list_item_txt - sayplayer {player_steam} "Name: {tele_name}, Coordinates: {tele_coords}"​


RAT Script Command: .REMTELEPORT:<name>
Event Variables:​
tele_name, tele_coords​
Group Attributes:​
tele_deleted_txt - sayplayer {player_steam} "Your teleport {tele_name} has been deleted."​
tele_delete_failed_txt - sayplayer {player_steam} "Unable to find a teleport destination named {tele_name}"​

RAT Script Command: .ADDTELEPORT:<name>

Event Variables:​
tele_name, tele_coords​
Group Attributes:​
tele_max_destinations​
tele_saved_txt - sayplayer {player_steam} "Teleport Saved, Name: {tele_name}, Coordinates: {tele_coords}"​
tele_max_destinations_txt - sayplayer {player_steam} "Sorry, but you have used all of your destinations, please overwrite or delete an existing destination and try again."​
tele_not_found_txt - sayplayer {player_steam} "You do not have a teleport named {tele_name} saved as a destination."​

RAT Script Command: .RESETTELEPORT:[name]
Description: (Typically an admin only command) This command will reset the wait time between teleports for a player. If no player name is passed in, the player that initiated the command will have their wait time reset.
 
Last edited:
Top