Class
ExperienceInviteOptions
NotReplicated
Used to customize a player invite prompt.
Used to customize a player invite prompt, such as to customize the prompt message, target a specific friend, or include launch data in the invite.
Properties 4#
InviteMessageIdstring | Asset ID that maps to a Notification asset type.ReadSafe |
InviteUserint64 | Roblox UserId of the specific friend to invite.ReadSafe |
LaunchDatastring | Used to set a parameter in Player:GetJoinData() when a friend
joins from the invite notification.ReadSafe |
PromptMessagestring | Custom text shown on the invite prompt for the sending player.ReadSafe |
InviteMessageId: string#
ReadSafe
Asset ID that maps to a Notification asset type. This asset is used to store/localize a custom string for the invite notification that friends receive. See Setting Notification Options for details.
InviteUser: int64#
ReadSafe
Roblox UserId of the specific friend to invite; if
not provided, the player will be prompted to pick from a list of friends.
LaunchData: string#
ReadSafe
Used to set a parameter in Player:GetJoinData() when a friend
joins from the invite notification; maximum of 200 characters. See
Include launch data
for a usage example.
PromptMessage: string#
ReadSafe
Custom text shown on the invite prompt for the sending player, for example "Ask your friends to join the adventure!" for a multi-friend invite prompt, or "Invite this friend to join the adventure!" for a specific friend invite prompt.
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild