TeleportToSpawnByName (Method): Difference between revisions

Latest revision as of 06:17, 27 April 2023

Local: This item should be used with a LocalScript in order to work as expected in online mode.

TeleportToSpawnByName( int placeId, string spawnName )
Returns	nil
Description:	Teleports someone like Teleport, but has a second argument allowing someone to teleport to a certain spawn. However, the spawn must have its Neutral property true.
Member of:	TeleportService

Example

This code will teleport a player to Crossroads, and if there is a spawn named "TeleportSpawn" then the player would spawn on it.

game:GetService('TeleportService'):TeleportToSpawnByName(1818, "TeleportSpawn")

@@ Line 1: / Line 1: @@
+{{local}}
 <onlyinclude>{{Method
 |name                 = TeleportToSpawnByName
-|returns              = [[nil]]
+|arguments            = [[int]] placeId, [[string]] spawnName
-|description          = Teleports someone like [[Teleport_(Method)|Teleport]], but has a second argument allowing someone to teleport to a certain spawn.
+|description          = Teleports someone like [[Teleport_(Method)|Teleport]], but has a second argument allowing someone to teleport to a certain spawn. However, the spawn must have its Neutral property true.
 |object               = TeleportService
 }}</onlyinclude>
@@ Line 8: / Line 9: @@
 {{clear floats}}
-{{Example|<pre>
+{{Example|
-game:GetService("TeleportService"):TeleportImpl("1818", "SomeSpawnName") --> Will teleport a player to crossroads, and if there was a spawn named "SomeSpawnName" then you would spawn there.
+This code will teleport a player to Crossroads, and if there is a spawn named "TeleportSpawn" then the player would spawn on it.
-</pre>}}
+<syntaxhighlight lang="lua">
+game:GetService('TeleportService'):TeleportToSpawnByName(1818, "TeleportSpawn")
+</syntaxhighlight>}}
+==See Also==
+*[[TeleportService]]
+*[[Teleport_(Method)|Teleport]]
 [[Category:Methods]]