Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GamePassService

A service associated with the legacy game pass system. Use MarketplaceService for all new work.

This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Tags: [NotCreatable, Service]

Member index 1

HistoryMember
484PlayerHasPass(player: Player, gamePassId: int64): bool
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 1

HistoryMember
311SetPlayerHasPassUrl(playerHasPassUrl: string): void

Description

The GamePassService is a service that supports legacy game passes using Asset IDs. MarketplaceService should be used for all new game passes.

For more information about game passes, please see Game Passes.

History 8

Members 1

PlayerHasPass

Parameters (2)
playerPlayer
gamePassIdint64
Returns (1)
bool

This function will not work with new game passes; use MarketplaceService:UserOwnsGamePassAsync() instead.

This function returns true if the Player has the specified legacy game pass. The result of this function may be cached, meaning it should not be relied on to give an up to date result.

See Passes for further information.

Legacy Game Passes

Historically, game passes on Roblox had an asset ID associated with them. Although such game passes still have an asset ID, they now also have a pass ID. All new game passes created only have a pass ID.

Whether you are using an Asset ID or a pass ID determines which API members you can use.

Asset ID (Legacy)Pass ID (Current)
Verify OwnershipGamePassService:PlayerHasPass()MarketplaceService:UserOwnsGamePassAsync()
Prompt a purchaseMarketplaceService:PromptPurchase()MarketplaceService:PromptGamePassPurchase()
Prompted purchase finishedMarketplaceService.PromptPurchaseFinishedMarketplaceService.PromptGamePassPurchaseFinished
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.
This function yields. It will block the calling thread until completion.

History 5

Tags: [Yields, Deprecated]

Removed members 1

SetPlayerHasPassUrl

Parameters (1)
playerHasPassUrlstring
Returns (1)
void

History 2

Settings