Open Asterune
PlaceService

PlaceService

Reports place metadata and controls place-level operations.

Service
game:GetService("PlaceService")
Inherits
Instance
Replication
Never

Behavior

PlaceService reports place metadata and controls place-level operations.

Summary

Members16
Properties8
  • All: { PlaceInfo } = nilparallel readread only

    The place descriptors registered for this project.

  • Arrival: any = nilparallel readread only

    The decoded data supplied by the previous place, or nil when no arrival data exists.

  • Current: PlaceInfo = nilparallel readread only

    The current place descriptor, including Key, Id, Name, Summary, Tags, and Meta.

  • LoadingScreen: ScreenGui?parallel readread only

    The ScreenGui carried into this place during arrival, or nil when unavailable.

  • Origin: PlaceInfo? = nilparallel readread only

    The previous place descriptor, or nil when no known origin exists.

  • ProjectId: stringparallel readread only

    The identifier of the current project.

  • Session: PlaceSession = nilparallel readread only

    The current session descriptor, including whether the session is private and its optional code.

  • Spawn: string? = nilparallel readread only

    The spawn identifier requested during arrival.

Methods7
Events1
  • Leaving: RBXScriptSignalparallel read

    Fires when departure from the place begins.

Properties

All

PlaceService.All: { PlaceInfo } = nil

The place descriptors registered for this project.

Arrival

PlaceService.Arrival: any = nil

The decoded data supplied by the previous place, or nil when no arrival data exists.

Current

PlaceService.Current: PlaceInfo = nil

The current place descriptor, including Key, Id, Name, Summary, Tags, and Meta.

LoadingScreen

PlaceService.LoadingScreen: ScreenGui?

The ScreenGui carried into this place during arrival, or nil when unavailable.

Origin

PlaceService.Origin: PlaceInfo? = nil

The previous place descriptor, or nil when no known origin exists.

ProjectId

PlaceService.ProjectId: string

The identifier of the current project.

Session

PlaceService.Session: PlaceSession = nil

The current session descriptor, including whether the session is private and its optional code.

Spawn

PlaceService.Spawn: string? = nil

The spawn identifier requested during arrival.

Methods

Back

PlaceService:Back(data: any?, options: MoveOptions?): boolean

Requests departure to the origin place. Returns false when no origin is recorded.

Find

PlaceService:Find(key: string): PlaceInfo?

Returns the place descriptor with the specified key, or nil if no match exists.

GetExecutionGroup

PlaceService:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

Go

PlaceService:Go(destination: string | number | PlaceInfo, data: any?, options: MoveOptions?): boolean

Requests departure to a destination place with optional arrival data and transfer options.

Send

PlaceService:Send(players: Player | { Player }, destination: string | number | PlaceInfo, data: any?, options: MoveOptions?): ()

Requests transfer of the specified players to another place. Available only on the server.

SetLoadingScreen

PlaceService:SetLoadingScreen(gui: ScreenGui?): ()

Selects a ScreenGui to carry during departure. Pass nil to carry no interface. Other instance classes cause an error.

Tagged

PlaceService:Tagged(tag: string): { PlaceInfo }

Returns the place descriptors containing the specified tag.

Events

Leaving

PlaceService.Leaving: RBXScriptSignal

Fires when departure from the place begins.

Inherited members

Inherited47
Instance47
Properties
ArchivableClassNameNameParent
Methods
AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
Events
AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying

Related APIs

Instance