Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PolicyService

Helps you build gameplay components for compliance.

This class is not replicated. Its interface does not cross the network boundary.
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.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 5

HistoryMember
652CanViewBrandProjectAsync(player: Player, brandProjectId: string): bool
462GetPolicyInfoForPlayerAsync(player: Instance): Dictionary
491GetPolicyInfoForServerRobloxOnlyAsync(): Dictionary
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)

Description

Important for getting your game to all audiences, PolicyService helps you build gameplay components that can be made compliant with various national regulations for multiple countries. This service is used to query information regarding policy compliance for players around the world based on age range, location, and platform type.

History 13

Members 5

CanViewBrandProjectAsync

Parameters (2)
playerPlayer
brandProjectIdstring
Returns (1)
bool
This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 1

Tags: [Yields]

GetPolicyInfoForPlayerAsync

Parameters (1)
playerInstance
Returns (1)
Dictionary

Returns policy information about a player which is based on geolocation, age group, and platform. The structure of the returned dictionary is as follows:

NameTypeRequired forDescription
AreAdsAllowedBooleanAny experience that includes immersive adsWhen true, the player might see immersive ads within an experience.
ArePaidRandomItemsRestrictedBooleanAny experience that has paid random itemsWhen true, the player cannot interact with paid (via in-experience currency bought with Robux, or Robux directly) random item generators.
AllowedExternalLinkReferencesArray of stringsAny experience that references external linksA list of external link references (for example, social media links, handles, or iconography) a player is permitted to see. Possible values include: "Discord", "Facebook", "Twitch", "YouTube", "X", "GitHub", and "Guilded".
IsContentSharingAllowedBooleanAny experience that allows users to share content off platformWhen true, the player is allowed to share content using APIs which open external sharing flows such as CaptureService:PromptShareCapture().
IsEligibleToPurchaseSubscriptionBooleanAny experience that wants to sell subscriptionsWhen true, the player is eligible to purchase subscriptions within an experience.
IsPaidItemTradingAllowedBooleanAny experience that allows users to purchase virtual items that they can trade with other playersWhen true, the player can trade virtual items that they purchased with in-experience currency or Robux.
IsSubjectToChinaPoliciesBooleanAny experience that is available in ChinaWhen true, an experience should enforce compliance changes. See this forum post for more information.

Exceptions

Like any async call, this needs to be wrapped in a pcall and error-handled properly. A full list of possible error messages and their reasons is as below:

MessageReason
Instance was not a playerDev's usage - The parameter is not a Player instance
Players not foundInternal error - Players object missing
This method cannot be called on the client for a non-local playerDev's usage - This method cannot be called on the client for a non-local player
GetPolicyInfoForPlayerAsync is called too many timesInternal error - GetPolicyInfoForPlayerAsync is called more than 100(current setting) times before http response coming back

See also:

This function yields. It will block the calling thread until completion.
Thread safetyUnsafe

History 2

Tags: [Yields]

GetPolicyInfoForServerRobloxOnlyAsync

Parameters (0)
No parameters.
Returns (1)
Dictionary
This function yields. It will block the calling thread until completion.
SecurityRobloxScriptSecurity
Thread safetyUnsafe

History 1

Tags: [Yields]

Settings