A service that provides an interface for you to manage and display personalized content recommendations.
- Memory category
- Instances
- Own members
- 8
- Inherited members
- 75
- Subclasses
- 0
- Siblings
- 608
Properties23
Property categoryBehavior
- Determines if an
Instanceand its descendants can be cloned usingInstance:Clone(), and can be saved/published. - Deprecated: This deprecated property is a variant of
Instance.Archivablewhich should be used instead.Use Archivable instead.
Property categoryData
Property categoryPermissions
- The set of capabilities allowed to be used for scripts inside this container.
- Indicates whether the instance is inside a sandboxed container.
- When enabled, the instance can only access abilities in its
Capabilitieslist.
No properties match the filters.
Methods50
Object:GetPropertyChangedSignal( property: string): RBXScriptSignal Get an event that fires when a given property of the object changes.Parameters Parameter Description property: stringThe property to connect to.Returns Type Description RBXScriptSignalA signal that fires whenever the property changes.- Returns true if an object's class matches or inherits from a given class.
Parameters Parameter Description className: stringThe class against which the Object's class will be checked. Case-sensitive.Returns Type Description booleanDescribes whether the Object's class matched or is a subclass of the given class. - Deprecated: This deprecated function is a variant of
Object:IsA()which should be used instead.Parameters Parameter className: stringReturns Type booleanUse IsA instead.
- Applies a tag to the instance.
Parameters Parameter Description tag: stringThe tag to apply to the instance. - This method destroys all of an instance's children.
- Create a copy of an instance and all its descendants, ignoring instances that are not
Archivable.Returns Type Description InstanceA copy of the instance, ornilif the instance is notArchivable. - Sets the
Instance.Parentproperty tonil, locks theInstance.Parentproperty, disconnects all connections, and callsDestroy()on all children. Instance:FindFirstAncestor( name: string): Instance Returns the first ancestor of theInstancewhoseInstance.Nameis equal to the given name.Parameters Parameter Description name: stringTheInstance.Nameto be looked for.Instance:FindFirstAncestorOfClass( className: string): Instance Returns the first ancestor of theInstancewhoseObject.ClassNameis equal to the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstAncestorWhichIsA( className: string): Instance Returns the first ancestor of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChild( name: string, recursive: boolean? = false): Instance Returns the first child of theInstancefound with the given name.Parameters Parameter Description name: stringTheInstance.Nameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstChildOfClass( className: string): Instance Parameters Parameter Description className: stringTheObject.ClassNameto be looked for.Instance:FindFirstChildWhichIsA(className: string,recursive: boolean? = false,): Instance Returns the first child of theInstancefor whomObject:IsA()returns true for the given className.Parameters Parameter Description className: stringTheObject.ClassNameto be searched for.recursive: boolean? = falseWhether or not the search should be conducted recursively.Instance:FindFirstDescendant( name: string): Instance Returns the first descendant found with the givenInstance.Name.Parameters Parameter Description name: stringTheInstance.Nameto search for.- Returns the
Actorassociated with the Instance, if any. Instance:GetAttribute( attribute: string): any Returns the value which has been assigned to the given attribute name.Parameters Parameter Description attribute: stringThe name of the attribute being retrieved.Returns Type Description anyThe value which has been assigned to the given attribute name. If no attribute has been assigned,nilis returned.Instance:GetAttributeChangedSignal( attribute: string): RBXScriptSignal Returns an event that fires when the given attribute changes.Parameters Parameter Description attribute: stringThe name of the specified attribute for which the change signal is being returned.Returns Type Description RBXScriptSignalAn event that fires when the given attribute changes.- Returns a dictionary of the instance's attributes.
Returns Type Description { [string]: any }A dictionary of string → variant pairs for each attribute where the string is the name of the attribute and the variant is a non-nil value. - Returns an array containing all of the instance's children.
Returns Type Description { Instance }An array containing the instance's children. Instance:GetDebugId( scopeLength: number? = 4): string Returns a coded string of the debug ID used internally by Roblox.Parameters Parameter Description scopeLength: number? = 4The scope length.Returns Type Description stringThe Debug ID string.- Returns an array containing all of the descendants of the instance.
Returns Type Description { Instance }An array containing the instance's descendants. - Returns a string describing the instance's ancestry.
- Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Parameters Parameter Description name: stringName of the property to query.selector: string?Optional selector for the pseudo instance you are targeting on the instance.Returns Type Description anyThe styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified. Instance:GetStyledPropertyChangedSignal( property: string): RBXScriptSignal Returns an event that fires when the given style property changes on the instance.Parameters Parameter Description property: stringName of the style property for which to listen for changes.Returns Type Description RBXScriptSignalEvent that fires when the given style property changes.- Gets an array of all tags applied to the instance.
Returns Type Description { any }An array of strings, each representing a tag applied to the instance. - Check whether the instance has a given tag.
Parameters Parameter Description tag: stringThe tag to check for on the instance.Returns Type Description booleantrueif the instance has the given tag,falseotherwise. Instance:IsAncestorOf( descendant: Instance): boolean Returns true if anInstanceis an ancestor of the given descendant.Instance:IsDescendantOf( ancestor: Instance): boolean Returnstrueif anInstanceis a descendant of the given ancestor.Instance:IsPropertyModified( property: string): boolean Returnstrueif the value stored in the specified property is not equal to the code-instantiated default.Parameters Parameter Description property: stringName of the property to query.Returns Type Description booleanBoolean indicating whether the property is modified from its code‑instantiated default.Instance:QueryDescendants( selector: string): { Instance } Returns an array containing all descendants of the instance that match theselectorstring.Parameters Parameter Description selector: stringSelector string used to filter elements.Returns Type Description { Instance }An array of instances (empty if nothing matched the selector).- Removes a tag from the instance.
Parameters Parameter Description tag: stringThe tag to remove from the instance. Instance:ResetPropertyToDefault( property: string) Resets a property to its default value.Parameters Parameter Description property: stringName of the property to reset.Instance:SetAttribute( attribute: string, value: any) Sets the attribute with the given name to the given value.Instance:WaitForChild( childName: string, timeOut: number): Instance Returns the child of theInstancewith the given name. If the child does not exist, it will yield the current thread until it does.Parameters Parameter Description childName: stringTheInstance.Nameto be looked for.timeOut: numberAn optional time out parameter.- Deprecated: This item is deprecated in favor of
Instance:Destroy()andInstance:ClearAllChildren(). If you must remove an object from the game, and wish to use the object later, set itsParentproperty tonilinstead of using this method.
Sets the object'sParenttonil, and does the same for all its descendants. - Deprecated: This item has been superseded by
Instance:GetChildren()which should be used in all new work.
Returns an array of the object's children.Returns Type Description { Instance }Array of child objects/instances.Use GetChildren instead.
- Deprecated: This deprecated function is a variant of
Instance:Clone()which should be used instead.Returns Type InstanceUse Clone instead.
- Deprecated: This deprecated function is a variant of
Instance:Destroy()which should be used instead.Use Destroy instead.
Instance:findFirstChild( name: string, recursive: boolean? = false): Instance Deprecated: This deprecated function is a variant ofInstance:FindFirstChild()which should be used instead.Returns Type InstanceUse FindFirstChild instead.
- Deprecated: This deprecated function is a variant of
Instance:GetChildren()which should be used instead.Returns Type { Instance }Use GetChildren instead.
Instance:isDescendantOf( ancestor: Instance): boolean Deprecated: This deprecated function is a variant ofInstance:IsDescendantOf()which should be used instead.Parameters Parameter ancestor: InstanceReturns Type booleanUse IsDescendantOf instead.
- Deprecated: This deprecated function is a variant of
Instance:Remove()which has also been deprecated. Neither function should be used in new work.Use Remove instead.
Defined byRecommendationService8
RecommendationService:GenerateItemListAsync( generateRecommendationItemListRequest: { [string]: any }): RecommendationPages Returns a paginated list of personalized recommendation items for the specified request configuration.Parameters Parameter Description generateRecommendationItemListRequest: { [string]: any }A dictionary containing the following fields:ConfigName— A unique ID for the specific configuration. This determines how the candidates are ranked.LocationId— A developer-defined string that specifies the location where the recommendation is used, such as"For_you"or"Lobby". This parameter will not affect the items returned, and it can help you track the performance of multiple recommendation features within your experience. Recommendation metrics for each individual location will be displayed in the Creator Hub.LocationIdmust be a string and cannot be"Other"or"other"as these values are reserved by the Creator Hub.PageSize— The number of items returned for each page.BoostCustomTags— A list of string tags. Any item with this tag will be boosted in ranking. Supports boosting one tag.CustomContexts— A table of key-value pairs used to pass in additional context data for ranking. For example,UserIdfor a Server script.
Returns Type Description RecommendationPagesARecommendationPagesobject containing the paginated list of recommended items for the given request configuration.RecommendationService:GetRecommendationItemAsync( itemId: string): { [string]: any } Retrieves a single registered recommendation item by itsItemId.Parameters Parameter Description itemId: stringThe ID of the item to retrieve.Returns Type Description { [string]: any }A dictionary representing the recommendation item with the following fields:ItemId— The unique ID for the item.ReferenceId— The developer-provided ID for the item.TracingId— An ID for tracking recommendation sessions. This will be empty when fetching a single item directly.Creator— A table containing theCreatorIdandCreatorType.Attributes— A list of content attributes associated with the item.CustomTags— A list of custom string tags.Visibility— An enum of typeRecommendationItemVisibility.
RecommendationService:LogActionEvent(actionType: Enum.RecommendationActionType,itemId: string,tracingId: string,actionEventDetails: { [string]: any }? = nil,) Logs a user action, such as a reaction or play, taken on a recommended item.Parameters Parameter Description actionType: Enum.RecommendationActionTypeThe enum for the type of action.itemId: stringThe item ID returned from registration andGenerateItemListAsync.tracingId: stringThe tracing ID returned from theGenerateItemListAsyncresponse. Each item has aTracingId.actionEventDetails: { [string]: any }? = nilA dictionary containing the following fields:Weight— A number representing the weight of the action. Default is 1.DestinationPlaceId— The ID of the place the user was sent to after the action. Used forPlay.CommentText— Any text associated with the action, such as a comment. Used forComment.ReactionType— A string describing the type of reaction, for example, "like" or "dislike". Used forAddReactionorRemoveReaction.
RecommendationService:LogImpressionEvent(impressionType: Enum.RecommendationImpressionType,itemId: string,tracingId: string,impressionEventDetails: { [string]: any }? = nil,) Logs an impression event, such as a user viewing a recommended item.Parameters Parameter Description impressionType: Enum.RecommendationImpressionTypeThe enum for the type of the impression.itemId: stringThe item ID returned from registration andGenerateItemListAsync.tracingId: stringThe tracing ID returned from theGenerateItemListAsyncresponse. Each item has aTracingId.impressionEventDetails: { [string]: any }? = nilA dictionary containing the following fields:Duration— The duration of the impression in seconds.Weight— A number representing the weight of the impression. Default is 1.ItemPosition— The position of the item in the recommendation list.DepartureIntent— TheRecommendationDepartureIntentindicating the user's intent when leaving a view. For example,Positiveif the view is considered good.
RecommendationService:LogPreferenceEvent(preferenceType: Enum.RecommendationPreferenceType,targetType: Enum.RecommendationPreferenceTargetType,targetId: string,tracingId: string? = "",itemId: string? = "",) Logs a user preference signal, such as follow or mute, toward a user, universe, or custom content tag.Parameters Parameter Description preferenceType: Enum.RecommendationPreferenceTypeThe enum for the type of preference.targetType: Enum.RecommendationPreferenceTargetTypeThe enum for the type of target.targetId: stringThe identifier of the preference target. The format depends ontargetType.tracingId: string? = ""The tracing ID returned from theGenerateItemListAsyncresponse. Pass an empty string if the preference originates outside a recommendation feed.itemId: string? = ""The item ID returned from theGenerateItemListAsyncresponse. Pass an empty string if the preference originates outside a recommendation feed.RecommendationService:RegisterItemAsync(player: Player,registerRecommendationItemsRequest: { [string]: any },): { [string]: any } Registers a new item on the server so it can be included in recommendations, returning the generatedItemIdandReferenceId.Parameters Parameter Description player: PlayerThe player who created the item.registerRecommendationItemsRequest: { [string]: any }A dictionary containing the following fields:ContentType— TheRecommendationItemContentTypespecifying the type of content. Type is defined in a generic way. For example, you can useStaticfor images,Dynamicfor videos, andInteractivefor 3D models that support interaction.ReferenceId— The developer-defined string that uniquely identifies the item.Duration— The duration of the content in seconds.Attributes— The table of attributes for the item, such asAssetIdorDescription.CustomTags— The list of string tags for filtering and boosting. Individual custom tags can't contain commas.Visibility— TheRecommendationItemVisibilityenum that controls the item's visibility, such asPublicorPrivate.
Returns Type Description { [string]: any }A table with only two fields:ItemIdandReferenceId.RecommendationService:RemoveItemAsync( itemId: string) Removes a registered item from the recommendation system by itsItemId.Parameters Parameter Description itemId: stringThe itemId to remove.RecommendationService:UpdateItemAsync( updateRecommendationItemRequest: { [string]: any }) Updates the mutable attributes of an existing recommendation item.Parameters Parameter Description updateRecommendationItemRequest: { [string]: any }A dictionary containing the following fields:ItemId— The ID of the item to update.ReferenceId— The new developer-defined string to identify the item.Creator— The new creator for the item. Creator is a table containing two fields:CreatorId: numberandCreatorType: Enum.CreatorType.Duration— The new duration for the content in seconds.Visibility— The new visibility setting for the item.Attributes— The new table of attributes for the item.CustomTags— The new list of string tags. Individual custom tags can't contain commas.
No methods match the filters.
Events10
Object.Changed: RBXScriptSignal<( property: string)> Fires immediately after a property of the object changes, with some limitations.Parameters Parameter property: string
Instance.AncestryChanged: RBXScriptSignal<( child: Instance, parent: Instance)> Fires when theInstance.Parentproperty of this object or one of its ancestors is changed.Instance.AttributeChanged: RBXScriptSignal<( attribute: string)> Fires whenever an attribute is changed on theInstance.Parameters Parameter attribute: stringInstance.ChildAdded: RBXScriptSignal<( child: Instance)> Fires after an object is parented to thisInstance.Parameters Parameter child: InstanceInstance.ChildRemoved: RBXScriptSignal<( child: Instance)> Fires after a child is removed from thisInstance.Parameters Parameter child: InstanceInstance.DescendantAdded: RBXScriptSignal<( descendant: Instance)> Fires after a descendant is added to theInstance.Parameters Parameter descendant: InstanceInstance.DescendantRemoving: RBXScriptSignal<( descendant: Instance)> Fires immediately before a descendant of theInstanceis removed.Parameters Parameter descendant: Instance- Fires immediately before (or is deferred until after) the instance is destroyed via
Instance:Destroy(). - Fires whenever any style property is changed on the instance, including when a property is set to
nil. Instance.childAdded: RBXScriptSignal<( child: Instance)> Deprecated: This deprecated event is a variant ofInstance.ChildAddedwhich should be used instead.Parameters Parameter child: InstanceUse ChildAdded instead.
No events match the filters.