mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-24 06:34:09 +00:00
sync rules
This commit is contained in:
parent
99b0af36fd
commit
a26b3123b5
901 changed files with 215240 additions and 4077 deletions
|
|
@ -54,7 +54,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.AssetId
|
||||
summary: |
|
||||
The asset ID that should be applied when applying this
|
||||
|
|
@ -61,7 +61,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.Instance
|
||||
summary: |
|
||||
A reference to the `Class.Instance` that should be applied when applying
|
||||
|
|
@ -84,7 +84,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.IsLayered
|
||||
summary: |
|
||||
Whether the `Class.Accessory` is layered or rigid.
|
||||
|
|
@ -106,7 +106,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.Order
|
||||
summary: |
|
||||
The layered clothing sort order, if the `Class.Accessory` is layered.
|
||||
|
|
@ -126,7 +126,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.Position
|
||||
summary: |
|
||||
The accessory adjustment position offset, if the `Class.Accessory` is
|
||||
|
|
@ -147,7 +147,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.Puffiness
|
||||
summary: |
|
||||
The layered clothing puffiness, if the `Class.Accessory` is layered.
|
||||
|
|
@ -167,7 +167,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.Rotation
|
||||
summary: |
|
||||
The accessory adjustment rotation offset, if the `Class.Accessory` is
|
||||
|
|
@ -188,7 +188,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AccessoryDescription.Scale
|
||||
summary: |
|
||||
The accessory adjustment scale, if the `Class.Accessory` is rigid.
|
||||
|
|
@ -208,7 +208,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods:
|
||||
- name: AccessoryDescription:GetAppliedInstance
|
||||
summary: |
|
||||
|
|
@ -227,6 +227,6 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -54,7 +54,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Accoutrement.AttachmentPoint
|
||||
summary: |
|
||||
The exact CFrame of the Accoutrement.
|
||||
|
|
@ -73,7 +73,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Accoutrement.AttachmentPos
|
||||
summary: |
|
||||
Sets the position of the object on the Player.
|
||||
|
|
@ -94,7 +94,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Accoutrement.AttachmentRight
|
||||
summary: |
|
||||
Sets the offset position of the object on the Player.
|
||||
|
|
@ -115,7 +115,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Accoutrement.AttachmentUp
|
||||
summary: |
|
||||
Sets the offset position of the object on the Player.
|
||||
|
|
@ -136,7 +136,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -119,6 +119,30 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: AnimationClipProvider:GetAnimations
|
||||
summary: |
|
||||
This function returns an `Class.InventoryPages` object which can be used
|
||||
to iterate over animations owned by a specific user.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The user ID of the user.
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: |
|
||||
An `Class.InventoryPages` of animations.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: AnimationClipProvider:GetAnimationsAsync
|
||||
summary: |
|
||||
This function returns an `Class.InventoryPages` object which can be used
|
||||
|
|
@ -147,30 +171,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: AnimationClipProvider:GetAnimations
|
||||
summary: |
|
||||
This function returns an `Class.InventoryPages` object which can be used
|
||||
to iterate over animations owned by a specific user.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The user ID of the user.
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: |
|
||||
An `Class.InventoryPages` of animations.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: AnimationClipProvider:GetClipEvaluatorAsync
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
|
|||
|
|
@ -0,0 +1,53 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: AnimationNodeDefinition
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: AnimationNodeDefinition.NodeId
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: string
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: AnimationNodeDefinition.NodeType
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: AnimationNodeType
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Animation
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -53,14 +53,16 @@ properties:
|
|||
methods:
|
||||
- name: AssetService:ComposeDecalAsync
|
||||
summary: |
|
||||
Creates a Decal instance that uses composite PBR textures created by
|
||||
layering the provided textures in the order they are provided in the
|
||||
`layers` array. Textures layer based on the alpha value of the ColorMap.
|
||||
Modifies an existing `Class.Decal` to contain a composite PBR textures
|
||||
created by layering the provided textures in the order they are provided
|
||||
in the `layers` array. Textures layer based on the alpha value of the
|
||||
color map.
|
||||
description: |
|
||||
Creates a new `Class.Decal` that contains a composed texture derived from
|
||||
one or more layered texture sets. Each set can include color, roughness,
|
||||
metalness, and normal maps. Each `layer` is composited in the order they
|
||||
are provided, with the ColorMap alpha channel used to determine blending.
|
||||
Modifies an existing `Class.Decal` to contain a composed texture derived
|
||||
from one or more layered texture sets. Each set can include color,
|
||||
roughness, metalness, and normal maps. Each layer in `layers` is
|
||||
composited in the order they are provided, with the color map alpha
|
||||
channel used to determine blending.
|
||||
|
||||
- There is a limit of 8 layers.
|
||||
- Layering order is bottom-to-top: the first layer in the list provides
|
||||
|
|
@ -81,15 +83,22 @@ methods:
|
|||
code_samples:
|
||||
- AssetService-ComposeDecalAsync
|
||||
parameters:
|
||||
- name: decal
|
||||
type: Decal
|
||||
default:
|
||||
summary: |
|
||||
A `Class.Decal` instance that will be modified to contain a
|
||||
representation of the layers. Any existing maps on this instance will
|
||||
be cleared.
|
||||
- name: layers
|
||||
type: Array
|
||||
default:
|
||||
summary: |
|
||||
An array of `Dictionary` tables that maps PBR names to ContentID.
|
||||
An array of dictionary tables that maps PBR names to
|
||||
`Datatype.Content` IDs.
|
||||
returns:
|
||||
- type: Decal
|
||||
summary: |
|
||||
A new `Class.Decal` containing the composed texture set.
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
|
|
@ -542,28 +551,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: AssetService:GetAssetIdsForPackageAsync
|
||||
summary: |
|
||||
Returns an array of asset IDs that are contained in a specified package.
|
||||
description: |
|
||||
Returns an array of asset IDs that are contained in a specified package.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: packageAssetId
|
||||
type: int64
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
Asset IDs that are contained in a specified package.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AssetService:GetAssetIdsForPackage
|
||||
summary: |
|
||||
Returns an array of asset IDs that are contained in a specified package.
|
||||
|
|
@ -586,6 +573,28 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AssetService:GetAssetIdsForPackageAsync
|
||||
summary: |
|
||||
Returns an array of asset IDs that are contained in a specified package.
|
||||
description: |
|
||||
Returns an array of asset IDs that are contained in a specified package.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: packageAssetId
|
||||
type: int64
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
Asset IDs that are contained in a specified package.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AssetService:GetAudioMetadataAsync
|
||||
summary: |
|
||||
Provides relevant metadata about a specific audio source.
|
||||
|
|
@ -789,7 +798,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRequire
|
||||
- LoadUnownedAsset
|
||||
- name: AssetService:PromptCreateAssetAsync
|
||||
summary: |
|
||||
Allows in-experience asset creation for users by prompting a publish
|
||||
|
|
@ -892,6 +901,28 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetCreateUpdate
|
||||
- name: AssetService:SearchAudio
|
||||
summary: |
|
||||
Finds audio assets matching a variety of search criteria.
|
||||
description: ''
|
||||
code_samples:
|
||||
- printing-search-audio-result-titles
|
||||
parameters:
|
||||
- name: searchParameters
|
||||
type: AudioSearchParams
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: AudioPages
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AssetService:SearchAudioAsync
|
||||
summary: |
|
||||
Finds audio assets matching a variety of search criteria.
|
||||
|
|
@ -938,27 +969,5 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AssetService:SearchAudio
|
||||
summary: |
|
||||
Finds audio assets matching a variety of search criteria.
|
||||
description: ''
|
||||
code_samples:
|
||||
- printing-search-audio-result-titles
|
||||
parameters:
|
||||
- name: searchParameters
|
||||
type: AudioSearchParams
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: AudioPages
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -227,7 +227,7 @@ properties:
|
|||
summary: |
|
||||
The voice style to be used by `Class.AudioTextToSpeech`.
|
||||
description: |
|
||||
The voice style to be used by`Class.AudioTextToSpeech`. A list of
|
||||
The voice style to be used by `Class.AudioTextToSpeech`. A list of
|
||||
available voices and their corresponding VoiceIds can be found in the
|
||||
[text-to-speech guide](../../../audio/objects.md#text-to-speech).
|
||||
code_samples: []
|
||||
|
|
|
|||
|
|
@ -482,7 +482,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AvatarCreationService:PromptCreateAvatarAssetAsync
|
||||
summary: |
|
||||
Prompts a `Class.Player` to purchase and create an avatar asset from an
|
||||
|
|
|
|||
|
|
@ -364,6 +364,31 @@ tags:
|
|||
deprecation_message: ''
|
||||
properties: []
|
||||
methods:
|
||||
- name: AvatarEditorService:CheckApplyDefaultClothing
|
||||
summary: |
|
||||
Used to apply default clothing to the `Class.HumanoidDescription` if
|
||||
necessary.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
The HumanoidDescription to check if default clothing is required.
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: |
|
||||
Returns a HumanoidDescription if default clothing was necessary.
|
||||
Otherwise returns `nil`.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: AvatarEditorService:CheckApplyDefaultClothingAsync
|
||||
summary: |
|
||||
Used to apply default clothing to the `Class.HumanoidDescription` if
|
||||
|
|
@ -394,51 +419,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- name: AvatarEditorService:CheckApplyDefaultClothing
|
||||
summary: |
|
||||
Used to apply default clothing to the `Class.HumanoidDescription` if
|
||||
necessary.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
The HumanoidDescription to check if default clothing is required.
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: |
|
||||
Returns a HumanoidDescription if default clothing was necessary.
|
||||
Otherwise returns `nil`.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- name: AvatarEditorService:ConformToAvatarRulesAsync
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AvatarEditorService:ConformToAvatarRules
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -458,7 +439,26 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: AvatarEditorService:ConformToAvatarRulesAsync
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: AvatarEditorService:GetAccessoryType
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -476,6 +476,26 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AvatarEditorService:GetAvatarRules
|
||||
summary: |
|
||||
Returns the platform Avatar rules for things such as scaling, default
|
||||
shirts and pants, number of wearable assets.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Dictionary
|
||||
summary: |
|
||||
A dictionary containing the platform Avatar rules for things like
|
||||
scaling, default shirts and pants, number of wearable assets, ect. See
|
||||
the example return in the main description above.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AvatarEditorService:GetAvatarRulesAsync
|
||||
summary: |
|
||||
Returns the platform Avatar rules for things such as scaling, default
|
||||
|
|
@ -541,26 +561,36 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: AvatarEditorService:GetAvatarRules
|
||||
- name: AvatarEditorService:GetBatchItemDetails
|
||||
summary: |
|
||||
Returns the platform Avatar rules for things such as scaling, default
|
||||
shirts and pants, number of wearable assets.
|
||||
Gets the item details for a list of items at once.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Dictionary
|
||||
parameters:
|
||||
- name: itemIds
|
||||
type: Array
|
||||
default:
|
||||
summary: |
|
||||
A dictionary containing the platform Avatar rules for things like
|
||||
scaling, default shirts and pants, number of wearable assets, ect. See
|
||||
the example return in the main description above.
|
||||
The list of item ids to get details of.
|
||||
- name: itemType
|
||||
type: AvatarItemType
|
||||
default:
|
||||
summary: |
|
||||
The type of the item ids provided.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
Returns an array of item details. See
|
||||
`Class.AvatarEditorService:GetBatchItemDetailsAsync()` for the
|
||||
response format.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetBatchItemDetailsAsync
|
||||
summary: |
|
||||
Gets the item details for a list of items at once.
|
||||
|
|
@ -593,28 +623,27 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetBatchItemDetails
|
||||
- name: AvatarEditorService:GetFavorite
|
||||
summary: |
|
||||
Gets the item details for a list of items at once.
|
||||
Returns if the `Class.Players.LocalPlayer` has favorited the given bundle
|
||||
or asset.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: itemIds
|
||||
type: Array
|
||||
- name: itemId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The list of item ids to get details of.
|
||||
The ID of the specified asset or bundle.
|
||||
- name: itemType
|
||||
type: AvatarItemType
|
||||
default:
|
||||
summary: |
|
||||
The type of the item ids provided.
|
||||
The `Enum.AvatarItemType` of the specified asset or bundle.
|
||||
returns:
|
||||
- type: Array
|
||||
- type: boolean
|
||||
summary: |
|
||||
Returns an array of item details. See
|
||||
`Class.AvatarEditorService:GetBatchItemDetailsAsync()` for the
|
||||
response format.
|
||||
Whether the `LocalPlayer` has favorited the given bundle or asset.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -622,6 +651,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetFavoriteAsync
|
||||
summary: |
|
||||
|
|
@ -654,27 +684,22 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetFavorite
|
||||
- name: AvatarEditorService:GetInventory
|
||||
summary: |
|
||||
Returns if the `Class.Players.LocalPlayer` has favorited the given bundle
|
||||
or asset.
|
||||
Returns an `Class.InventoryPages` object with information about owned
|
||||
items in the users inventory with the given AvatarAssetTypes.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: itemId
|
||||
type: int64
|
||||
- name: assetTypes
|
||||
type: Array
|
||||
default:
|
||||
summary: |
|
||||
The ID of the specified asset or bundle.
|
||||
- name: itemType
|
||||
type: AvatarItemType
|
||||
default:
|
||||
summary: |
|
||||
The `Enum.AvatarItemType` of the specified asset or bundle.
|
||||
The `Enum.AvatarAssetType` that can will be checked for in the
|
||||
player's inventory.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
Whether the `LocalPlayer` has favorited the given bundle or asset.
|
||||
- type: InventoryPages
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -724,22 +749,28 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetInventory
|
||||
- name: AvatarEditorService:GetItemDetails
|
||||
summary: |
|
||||
Returns an `Class.InventoryPages` object with information about owned
|
||||
items in the users inventory with the given AvatarAssetTypes.
|
||||
Returns the item details for the given item.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: assetTypes
|
||||
type: Array
|
||||
- name: itemId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Enum.AvatarAssetType` that can will be checked for in the
|
||||
player's inventory.
|
||||
The ID of the item whose details are being retrieved.
|
||||
- name: itemType
|
||||
type: AvatarItemType
|
||||
default:
|
||||
summary: |
|
||||
An enum value indicating the type of item whose details are being
|
||||
retrieved.
|
||||
returns:
|
||||
- type: InventoryPages
|
||||
summary: ''
|
||||
- type: Dictionary
|
||||
summary: |
|
||||
A table containing the item info for the retrieved item. See above for
|
||||
a sample table.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -747,7 +778,6 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetItemDetailsAsync
|
||||
summary: |
|
||||
|
|
@ -816,28 +846,22 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetItemDetails
|
||||
- name: AvatarEditorService:GetOutfitDetails
|
||||
summary: |
|
||||
Returns the item details for the given item.
|
||||
Returns the outfit details for the given outfit.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: itemId
|
||||
- name: outfitId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The ID of the item whose details are being retrieved.
|
||||
- name: itemType
|
||||
type: AvatarItemType
|
||||
default:
|
||||
summary: |
|
||||
An enum value indicating the type of item whose details are being
|
||||
retrieved.
|
||||
The ID of the outfit whose details are being retrieved.
|
||||
returns:
|
||||
- type: Dictionary
|
||||
summary: |
|
||||
A table containing the item info for the retrieved item. See above for
|
||||
a sample table.
|
||||
A table containing the outfit info for the retrieved outfit. See above
|
||||
for a sample table.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -910,22 +934,23 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetOutfitDetails
|
||||
- name: AvatarEditorService:GetOutfits
|
||||
summary: |
|
||||
Returns the outfit details for the given outfit.
|
||||
Returns outfit data for the `Class.Players.LocalPlayer`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: outfitId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The ID of the outfit whose details are being retrieved.
|
||||
- name: outfitSource
|
||||
type: OutfitSource
|
||||
default: All
|
||||
summary: ''
|
||||
- name: outfitType
|
||||
type: OutfitType
|
||||
default: All
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Dictionary
|
||||
summary: |
|
||||
A table containing the outfit info for the retrieved outfit. See above
|
||||
for a sample table.
|
||||
- type: OutfitPages
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -933,6 +958,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetOutfitsAsync
|
||||
summary: |
|
||||
|
|
@ -1004,23 +1030,31 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetOutfits
|
||||
- name: AvatarEditorService:GetRecommendedAssets
|
||||
summary: |
|
||||
Returns outfit data for the `Class.Players.LocalPlayer`.
|
||||
Returns a list of recommended assets based on a given `Enum.AssetType` and
|
||||
asset ID.
|
||||
description: ''
|
||||
code_samples: []
|
||||
code_samples:
|
||||
- getting-a-hat-recommendation
|
||||
parameters:
|
||||
- name: outfitSource
|
||||
type: OutfitSource
|
||||
default: All
|
||||
summary: ''
|
||||
- name: outfitType
|
||||
type: OutfitType
|
||||
default: All
|
||||
summary: ''
|
||||
- name: assetType
|
||||
type: AvatarAssetType
|
||||
default:
|
||||
summary: |
|
||||
The type of asset recommendations to retrieve recommendations for.
|
||||
Only affects the response when item based recommendations don't exist
|
||||
for the given `contextAssetId`.
|
||||
- name: contextAssetId
|
||||
type: int64
|
||||
default: 0
|
||||
summary: |
|
||||
The ID of an asset with a type matching the provided assetType used
|
||||
for context when retrieving recommendations.
|
||||
returns:
|
||||
- type: OutfitPages
|
||||
summary: ''
|
||||
- type: Array
|
||||
summary: |
|
||||
A list of recommendations based on the given `Enum.AssetType`.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -1028,7 +1062,6 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetRecommendedAssetsAsync
|
||||
summary: |
|
||||
|
|
@ -1097,31 +1130,21 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetRecommendedAssets
|
||||
- name: AvatarEditorService:GetRecommendedBundles
|
||||
summary: |
|
||||
Returns a list of recommended assets based on a given `Enum.AssetType` and
|
||||
asset ID.
|
||||
Returns a list of recommended bundles for a given bundle id.
|
||||
description: ''
|
||||
code_samples:
|
||||
- getting-a-hat-recommendation
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: assetType
|
||||
type: AvatarAssetType
|
||||
- name: bundleId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The type of asset recommendations to retrieve recommendations for.
|
||||
Only affects the response when item based recommendations don't exist
|
||||
for the given `contextAssetId`.
|
||||
- name: contextAssetId
|
||||
type: int64
|
||||
default: 0
|
||||
summary: |
|
||||
The ID of an asset with a type matching the provided assetType used
|
||||
for context when retrieving recommendations.
|
||||
A list of recommended bundles.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A list of recommendations based on the given `Enum.AssetType`.
|
||||
The bundle ID that the recommended bundles will be returned for.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -1190,29 +1213,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:GetRecommendedBundles
|
||||
summary: |
|
||||
Returns a list of recommended bundles for a given bundle id.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: bundleId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
A list of recommended bundles.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
The bundle ID that the recommended bundles will be returned for.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:PromptAllowInventoryReadAccess
|
||||
summary: |
|
||||
Prompts the `Class.Players.LocalPlayer` to allow the developer to read
|
||||
|
|
@ -1417,6 +1417,29 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- PlatformAvatarEditing
|
||||
- name: AvatarEditorService:SearchCatalog
|
||||
summary: |
|
||||
Returns a `Class.CatalogPages` object containing the result of the given
|
||||
search.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: searchParameters
|
||||
type: CatalogSearchParams
|
||||
default:
|
||||
summary: |
|
||||
An object containing the parameters used for the search.
|
||||
returns:
|
||||
- type: CatalogPages
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:SearchCatalogAsync
|
||||
summary: |
|
||||
Returns a `Class.CatalogPages` object containing the result of the given
|
||||
|
|
@ -1445,29 +1468,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: AvatarEditorService:SearchCatalog
|
||||
summary: |
|
||||
Returns a `Class.CatalogPages` object containing the result of the given
|
||||
search.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: searchParameters
|
||||
type: CatalogSearchParams
|
||||
default:
|
||||
summary: |
|
||||
An object containing the parameters used for the search.
|
||||
returns:
|
||||
- type: CatalogPages
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
events:
|
||||
- name: AvatarEditorService.PromptAllowInventoryReadAccessCompleted
|
||||
summary: |
|
||||
|
|
|
|||
|
|
@ -23,6 +23,34 @@ tags:
|
|||
deprecation_message: ''
|
||||
properties: []
|
||||
methods:
|
||||
- name: BadgeService:AwardBadge
|
||||
summary: |
|
||||
Award a badge to a player given the ID of each.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player.UserId` of the user the badge is to be awarded to.
|
||||
- name: badgeId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The ID of the badge to be awarded.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
Boolean of `true` if the badge was awarded successfully.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetManagement
|
||||
- name: BadgeService:AwardBadgeAsync
|
||||
summary: |
|
||||
Award a badge to a player given the ID of each.
|
||||
|
|
@ -69,34 +97,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetManagement
|
||||
- name: BadgeService:AwardBadge
|
||||
summary: |
|
||||
Award a badge to a player given the ID of each.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player.UserId` of the user the badge is to be awarded to.
|
||||
- name: badgeId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The ID of the badge to be awarded.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
Boolean of `true` if the badge was awarded successfully.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetManagement
|
||||
- name: BadgeService:CheckUserBadgesAsync
|
||||
summary: |
|
||||
Checks a list of badge IDs against a `Class.Player.UserId|UserId` and
|
||||
|
|
@ -113,6 +113,9 @@ methods:
|
|||
`Class.LocalScript`, only the `Class.Player.UserId|UserId` of the local
|
||||
user whose client is running the script can be used.
|
||||
|
||||
This API's behavior will change soon. For more information, see
|
||||
[this DevForum announcement](https://devforum.roblox.com/t/upcoming-breaking-change-to-checkuserbadgesasync-userhasbadgeasync-and-badges-web-apis/4438920).
|
||||
|
||||
Rate limit is `10 + 5 * [number of players]` per minute in each server.
|
||||
code_samples:
|
||||
- badges---checking-earned-badges-batch
|
||||
|
|
@ -288,13 +291,15 @@ methods:
|
|||
Checks and returns whether a `Class.Player` owns a badge given their
|
||||
`Class.Player.UserId|UserId` and the badge ID. You can call the function
|
||||
from the server in a `Class.Script` or `Class.ModuleScript` eventually
|
||||
required by a `Class.Script`, and the user in question must be present in
|
||||
the server for the query to run. When calling the method from the client
|
||||
in a `Class.LocalScript`, it only works for the local user whose client is
|
||||
required by a `Class.Script`. When calling the method from the client in a
|
||||
`Class.LocalScript`, it only works for the local user whose client is
|
||||
running the script.
|
||||
|
||||
Any badge for any experience can be queried, no matter who created the
|
||||
badge or which experience it is used for.
|
||||
|
||||
This API's behavior will change soon. For more information, see
|
||||
[this DevForum announcement](https://devforum.roblox.com/t/upcoming-breaking-change-to-checkuserbadgesasync-userhasbadgeasync-and-badges-web-apis/4438920).
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
|
|
@ -330,14 +335,16 @@ methods:
|
|||
Checks and returns whether a `Class.Player` owns a badge given their
|
||||
`Class.Player.UserId|UserId` and the badge ID. You can call this method
|
||||
from the server in a `Class.Script` or `Class.ModuleScript` eventually
|
||||
required by a `Class.Script`, and the user in question must be present in
|
||||
the server for the query to run. When calling this method from the client
|
||||
in a `Class.LocalScript`, it only works for the local user whose client is
|
||||
required by a `Class.Script`. When calling this method from the client in
|
||||
a `Class.LocalScript`, it only works for the local user whose client is
|
||||
running the script.
|
||||
|
||||
Any badge for any experience can be queried, no matter who created the
|
||||
badge or which experience it is used for.
|
||||
|
||||
This API's behavior will change soon. For more information, see
|
||||
[this DevForum announcement](https://devforum.roblox.com/t/upcoming-breaking-change-to-checkuserbadgesasync-userhasbadgeasync-and-badges-web-apis/4438920).
|
||||
|
||||
Rate limit is `50 + 35 * [number of players]` per minute.
|
||||
code_samples:
|
||||
- badges---checking-earned-badges
|
||||
|
|
|
|||
|
|
@ -0,0 +1,40 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: BaseCoreGuiConfiguration
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants:
|
||||
- CapturesViewConfiguration
|
||||
- PlayerListConfiguration
|
||||
- SelfViewConfiguration
|
||||
tags:
|
||||
- NotCreatable
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: BaseCoreGuiConfiguration.Enabled
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: State
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -38,7 +38,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BaseWrap.CageMeshId
|
||||
summary: |
|
||||
Asset ID for cage mesh.
|
||||
|
|
@ -59,7 +59,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BaseWrap.CageOrigin
|
||||
summary: |
|
||||
Cage mesh offset relative to parent `Class.MeshPart`.
|
||||
|
|
@ -80,7 +80,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BaseWrap.CageOriginWorld
|
||||
summary: |
|
||||
Cage mesh offset in world space.
|
||||
|
|
@ -101,7 +101,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BaseWrap.HSRAssetId
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -118,7 +118,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BaseWrap.ImportOrigin
|
||||
summary: |
|
||||
Describes where a global zero was while authoring the cage mesh in an
|
||||
|
|
@ -177,7 +177,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BaseWrap.ImportOriginWorld
|
||||
summary: |
|
||||
Describes where the origin (in world space) was while authoring the cage
|
||||
|
|
@ -200,7 +200,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.HeadColor3
|
||||
summary: |
|
||||
Sets the color of the head, as a `Datatype.Color3`.
|
||||
|
|
@ -62,7 +62,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.LeftArmColor
|
||||
summary: |
|
||||
Sets the color of the left arm, as a `Datatype.BrickColor`.
|
||||
|
|
@ -83,7 +83,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.LeftArmColor3
|
||||
summary: |
|
||||
Sets the color of the left arm, as a `Datatype.Color3`.
|
||||
|
|
@ -105,7 +105,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.LeftLegColor
|
||||
summary: |
|
||||
Sets the color of the left leg, as a `Datatype.BrickColor`.
|
||||
|
|
@ -126,7 +126,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.LeftLegColor3
|
||||
summary: |
|
||||
Sets the color of the left leg, as a `Datatype.Color3`.
|
||||
|
|
@ -148,7 +148,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.RightArmColor
|
||||
summary: |
|
||||
Sets the color of the right arm, as a `Datatype.BrickColor`.
|
||||
|
|
@ -169,7 +169,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.RightArmColor3
|
||||
summary: |
|
||||
Sets the color of the right arm, as a `Datatype.Color3`.
|
||||
|
|
@ -191,7 +191,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.RightLegColor
|
||||
summary: |
|
||||
Sets the color of the right leg, as a `Datatype.BrickColor`.
|
||||
|
|
@ -212,7 +212,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.RightLegColor3
|
||||
summary: |
|
||||
Sets the color of the right leg, as a `Datatype.Color3`.
|
||||
|
|
@ -234,7 +234,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.TorsoColor
|
||||
summary: |
|
||||
Sets the color of the torso, as a `Datatype.BrickColor`.
|
||||
|
|
@ -255,7 +255,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyColors.TorsoColor3
|
||||
summary: |
|
||||
Sets the color of the torso, as a `Datatype.Color3`.
|
||||
|
|
@ -277,7 +277,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyPartDescription.BodyPart
|
||||
summary: |
|
||||
The type of body part.
|
||||
|
|
@ -59,7 +59,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyPartDescription.Color
|
||||
summary: |
|
||||
The `Datatype.Color3` for this body part.
|
||||
|
|
@ -78,7 +78,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyPartDescription.HeadShape
|
||||
summary: |
|
||||
Specifies the head shape identifier to apply to a Dynamic Head when this
|
||||
|
|
@ -132,7 +132,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: BodyPartDescription.Instance
|
||||
summary: |
|
||||
A reference to the `Class.Instance` that should be applied when applying
|
||||
|
|
@ -157,7 +157,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: CapturesViewConfiguration
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- BaseCoreGuiConfiguration
|
||||
descendants: []
|
||||
tags:
|
||||
- NotCreatable
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: CapturesViewConfiguration.Open
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: State
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -17,6 +17,23 @@ descendants: []
|
|||
tags: []
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: CharacterMesh.BaseTextureContent
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Content
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: CharacterMesh.BaseTextureId
|
||||
summary: |
|
||||
The texture of a CharacterMesh. It can be overridden by Shirts, Pants,
|
||||
|
|
@ -37,7 +54,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: CharacterMesh.BodyPart
|
||||
summary: |
|
||||
The part of the Character's body that is affected.
|
||||
|
|
@ -56,7 +73,24 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: CharacterMesh.MeshContent
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Content
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: CharacterMesh.MeshId
|
||||
summary: |
|
||||
Used to load a mesh file, and apply it to the given BodyPart.
|
||||
|
|
@ -75,7 +109,24 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: CharacterMesh.OverlayTextureContent
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Content
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: CharacterMesh.OverlayTextureId
|
||||
summary: |
|
||||
The assetId of the overlay texture. The overlay covers Shirts, Pants,
|
||||
|
|
@ -96,7 +147,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -63,6 +63,29 @@ properties:
|
|||
capabilities:
|
||||
- Basic
|
||||
methods:
|
||||
- name: CompositeValueCurve:GetComponentCurves
|
||||
summary: |
|
||||
Returns the child curves with the given names for the
|
||||
`Class.CompositeValueCurve.CurveType|CurveType` of this
|
||||
`Class.CompositeValueCurve`.
|
||||
description: |
|
||||
This method returns the child curves with the given names for the
|
||||
`Class.CompositeValueCurve.CurveType|CurveType` of this
|
||||
`Class.CompositeValueCurve`, in the order given by the list of child
|
||||
curves outlined at the top of this page. Any curve that does not exist
|
||||
prior to calling this method will be created and added as a child with the
|
||||
appropriate name. That new curve will be an empty `Class.FloatCurve`.
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Instances
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: CompositeValueCurve:GetValueAtTime
|
||||
summary: |
|
||||
Returns the sampled animated value at the passed `time` argument.
|
||||
|
|
@ -95,28 +118,5 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: CompositeValueCurve:GetComponentCurves
|
||||
summary: |
|
||||
Returns the child curves with the given names for the
|
||||
`Class.CompositeValueCurve.CurveType|CurveType` of this
|
||||
`Class.CompositeValueCurve`.
|
||||
description: |
|
||||
This method returns the child curves with the given names for the
|
||||
`Class.CompositeValueCurve.CurveType|CurveType` of this
|
||||
`Class.CompositeValueCurve`, in the order given by the list of child
|
||||
curves outlined at the top of this page. Any curve that does not exist
|
||||
prior to calling this method will be created and added as a child with the
|
||||
appropriate name. That new curve will be an empty `Class.FloatCurve`.
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Instances
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Basic
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.BaseMoveSpeed
|
||||
summary: |
|
||||
The base linear movement speed used by all controllers.
|
||||
|
|
@ -65,7 +65,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.BaseTurnSpeed
|
||||
summary: |
|
||||
The base angular turning speed used by all controllers.
|
||||
|
|
@ -85,7 +85,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.ClimbSensor
|
||||
summary: |
|
||||
A reference to the sensor data used while a `Class.ClimbController` is
|
||||
|
|
@ -112,7 +112,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.FacingDirection
|
||||
summary: |
|
||||
The unit vector describing the desired direction to face.
|
||||
|
|
@ -134,7 +134,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.GroundSensor
|
||||
summary: |
|
||||
A reference to the sensor data used while a `Class.GroundController` is
|
||||
|
|
@ -161,7 +161,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.MovingDirection
|
||||
summary: |
|
||||
The vector describing the desired direction to move in.
|
||||
|
|
@ -185,7 +185,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.RootPart
|
||||
summary: |
|
||||
The `Class.BasePart` where the controller's forces and torques are
|
||||
|
|
@ -208,7 +208,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: ControllerManager.UpDirection
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -225,7 +225,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -0,0 +1,70 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: CoreGuiConfiguration
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags:
|
||||
- NotCreatable
|
||||
- Service
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: CoreGuiConfiguration.CapturesViewConfiguration
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CapturesViewConfiguration
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: CoreGuiConfiguration.PlayerListConfiguration
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: PlayerListConfiguration
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: CoreGuiConfiguration.SelfViewConfiguration
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: SelfViewConfiguration
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -442,6 +442,24 @@ properties:
|
|||
can_load: false
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: DataModel.RunService
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags:
|
||||
- ReadOnly
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: false
|
||||
can_save: false
|
||||
capabilities: []
|
||||
- name: DataModel.VIPServerId
|
||||
summary: |
|
||||
A string that could identify the current server as a private server.
|
||||
|
|
|
|||
|
|
@ -192,5 +192,31 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- DataStore
|
||||
- name: DataStoreService:SetRateLimitForRequestType
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: requestType
|
||||
type: DataStoreRequestType
|
||||
default:
|
||||
summary: ''
|
||||
- name: baseLimit
|
||||
type: int
|
||||
default:
|
||||
summary: ''
|
||||
- name: perPlayerLimit
|
||||
type: int
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- DataStore
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -202,6 +202,23 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Decal.Rotation
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Appearance
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Decal.RoughnessMap
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
|
|||
|
|
@ -196,7 +196,7 @@ methods:
|
|||
It is recommended to use `Class.EncodingService.GetDecompressedBufferSize`
|
||||
to find out the decompressed data size before attempting to decompress.
|
||||
This is very important if the input buffer contents are outside of your
|
||||
control (for example, from a client `Class.RemoveEvent`)
|
||||
control (for example, from a client `Class.RemoteEvent`)
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: input
|
||||
|
|
|
|||
|
|
@ -196,6 +196,29 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- CSG
|
||||
- name: GeometryService:GenerateFragmentSites
|
||||
summary: |
|
||||
This API has not been released.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: part
|
||||
type: BasePart
|
||||
default:
|
||||
summary: ''
|
||||
- name: options
|
||||
type: Dictionary
|
||||
default: nil
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Array
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- CSG
|
||||
- name: GeometryService:IntersectAsync
|
||||
summary: |
|
||||
Creates one or more `Class.PartOperation|PartOperations` from the
|
||||
|
|
|
|||
|
|
@ -1215,7 +1215,7 @@ events:
|
|||
default:
|
||||
summary: |
|
||||
An `Class.InputObject`, which contains useful data for querying user
|
||||
input such as the`Enum.UserInputType|type of input`,
|
||||
input such as the `Enum.UserInputType|type of input`,
|
||||
`Enum.UserInputState|state of input`, and
|
||||
`Class.InputObject.Position|screen coordinates of the input`.
|
||||
tags: []
|
||||
|
|
@ -1248,7 +1248,7 @@ events:
|
|||
default:
|
||||
summary: |
|
||||
An `Class.InputObject`, which contains useful data for querying user
|
||||
input such as the`Enum.UserInputType|type of input`,
|
||||
input such as the `Enum.UserInputType|type of input`,
|
||||
`Enum.UserInputState|state of input`, and
|
||||
`Class.InputObject.Position|screen coordinates of the input`.
|
||||
tags: []
|
||||
|
|
@ -1279,7 +1279,7 @@ events:
|
|||
default:
|
||||
summary: |
|
||||
An `Class.InputObject`, which contains useful data for querying user
|
||||
input such as the`Enum.UserInputType`, `Enum.UserInputState`, and
|
||||
input such as the `Enum.UserInputType`, `Enum.UserInputState`, and
|
||||
`Class.InputObject.Position`.
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -1580,9 +1580,6 @@ events:
|
|||
`Enum.UserInputState.Change` if the player moves their finger during the
|
||||
gesture, and finally `Enum.UserInputState.End`. The delay is platform
|
||||
dependent; in Studio it is a little longer than one second.
|
||||
|
||||
Since this event only requires one finger, this event can be simulated in
|
||||
Studio using the emulator and a mouse.
|
||||
code_samples:
|
||||
- Move-UI-Element-with-TouchLongPress
|
||||
parameters:
|
||||
|
|
@ -1623,9 +1620,6 @@ events:
|
|||
addition, it fires multiple times: `Enum.UserInputState.Begin` after a
|
||||
brief delay, `Enum.UserInputState.Change` when the player moves their
|
||||
finger during the gesture, and finally with `Enum.UserInputState.End`.
|
||||
|
||||
This event cannot be simulated in Studio using the emulator and a mouse;
|
||||
you must have a real touch-enabled device to fire it.
|
||||
code_samples:
|
||||
- Panning-UI-Element
|
||||
parameters:
|
||||
|
|
@ -1675,10 +1669,6 @@ events:
|
|||
brief delay, `Enum.UserInputState.Change` when the player moves a finger
|
||||
during the gesture, and finally with `Enum.UserInputState.End`. It should
|
||||
be noted that the scale should be used **multiplicatively**.
|
||||
|
||||
Since this event requires at least two fingers, it is not possible to
|
||||
simulate it in Studio using the emulator and a mouse; you must have a real
|
||||
touch-enabled device.
|
||||
code_samples:
|
||||
- Pinch-Pull-Scaling
|
||||
parameters:
|
||||
|
|
@ -1726,10 +1716,6 @@ events:
|
|||
addition, it fires multiple times: `Enum.UserInputState.Begin` after a
|
||||
brief delay, `Enum.UserInputState.Change` when the player moves a finger
|
||||
during the gesture, and finally with `Enum.UserInputState.End`.
|
||||
|
||||
Since this event requires at least two fingers, it is not possible to be
|
||||
simulated in Studio using the emulator and a mouse; you must have a real
|
||||
touch-enabled device.
|
||||
code_samples:
|
||||
- Touch-Rotation
|
||||
parameters:
|
||||
|
|
@ -1769,9 +1755,6 @@ events:
|
|||
gesture (Up, Down, Left or Right) and the number of touch points involved
|
||||
in the gesture. Swipe gestures are often used to change tabs in mobile
|
||||
UIs.
|
||||
|
||||
Since this event only requires one finger, it can be simulated in Studio
|
||||
using the emulator and a mouse.
|
||||
code_samples:
|
||||
- Bouncing-Color-Picker
|
||||
parameters:
|
||||
|
|
@ -1802,9 +1785,6 @@ events:
|
|||
`Class.GuiObject.TouchPan` and/or `Class.GuiObject.TouchSwipe`). It fires
|
||||
with a table of `Datatype.Vector2` objects that describe the relative
|
||||
positions of the fingers involved in the gesture.
|
||||
|
||||
Since this event only requires one finger, it can be simulated in Studio
|
||||
using the emulator and a mouse.
|
||||
code_samples:
|
||||
- Tap-Transparency-Toggle
|
||||
parameters:
|
||||
|
|
|
|||
|
|
@ -585,6 +585,24 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- name: GuiService:GetInsetArea
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: screenInsets
|
||||
type: ScreenInsets
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Rect
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- name: GuiService:GetInspectMenuEnabled
|
||||
summary: |
|
||||
Returns whether the avatar inspection menu is enabled.
|
||||
|
|
@ -643,7 +661,7 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: GuiService:InspectPlayerFromUserId
|
||||
summary: |
|
||||
Allows the avatar inspection menu to appear showing the user that has the
|
||||
|
|
@ -675,7 +693,7 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: GuiService:IsTenFootInterface
|
||||
summary: |
|
||||
Returns `true` if the client is using the ten foot interface, a special
|
||||
|
|
|
|||
|
|
@ -1,797 +0,0 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: HandRigDescription
|
||||
type: class
|
||||
memory_category: Animation
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags:
|
||||
- NotBrowsable
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: HandRigDescription.Index1
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Index1TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Index2
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Index2TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Index3
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Index3TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.IndexRange
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Vector3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Range
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.IndexSize
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Size
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Middle1
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Middle1TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Middle2
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Middle2TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Middle3
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Middle3TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.MiddleRange
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Vector3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Range
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.MiddleSize
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Size
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Pinky1
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Pinky1TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Pinky2
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Pinky2TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Pinky3
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Pinky3TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.PinkyRange
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Vector3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Range
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.PinkySize
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Size
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Ring1
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Ring1TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Ring2
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Ring2TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Ring3
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Ring3TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.RingRange
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Vector3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Range
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.RingSize
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Size
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Side
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: HandRigDescriptionSide
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Thumb1
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Thumb1TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Thumb2
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Thumb2TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Thumb3
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Mapping
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.Thumb3TposeAdjustment
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CFrame
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Tpose
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.ThumbRange
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Vector3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Range
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription.ThumbSize
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Size
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Animation
|
||||
methods:
|
||||
- name: HandRigDescription:GetFingerControl
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: fingerIndex
|
||||
type: int
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Vector3
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription:GetFingerTip
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: fingerIndex
|
||||
type: int
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Vector3
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription:SetFingerControl
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: fingerIndex
|
||||
type: int
|
||||
default:
|
||||
summary: ''
|
||||
- name: control
|
||||
type: Vector3
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: HandRigDescription:SetFingerTip
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: fingerIndex
|
||||
type: int
|
||||
default:
|
||||
summary: ''
|
||||
- name: point
|
||||
type: Vector3
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -84,7 +84,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.AutomaticScalingEnabled
|
||||
summary: |
|
||||
|
|
@ -110,7 +110,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.AutoRotate
|
||||
summary: |
|
||||
AutoRotate sets whether or not the Humanoid will automatically rotate to
|
||||
|
|
@ -165,7 +165,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.BreakJointsOnDeath
|
||||
summary: |
|
||||
|
|
@ -187,7 +187,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.CameraOffset
|
||||
summary: |
|
||||
|
|
@ -216,7 +216,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.CollisionType
|
||||
summary: |
|
||||
|
|
@ -239,7 +239,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.DisplayDistanceType
|
||||
summary: |
|
||||
Controls the distance behavior of the humanoid's name and health display.
|
||||
|
|
@ -276,7 +276,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.DisplayName
|
||||
summary: |
|
||||
Sets the text of a Humanoid, displayed above their head.
|
||||
|
|
@ -315,7 +315,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.EvaluateStateMachine
|
||||
summary: |
|
||||
Used to disable the internal physics and state machine of the Humanoid.
|
||||
|
|
@ -363,7 +363,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.FloorMaterial
|
||||
summary: |
|
||||
|
|
@ -416,7 +416,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Health
|
||||
summary: |
|
||||
|
|
@ -474,7 +474,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.HealthDisplayDistance
|
||||
summary: |
|
||||
|
|
@ -503,7 +503,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.HealthDisplayType
|
||||
summary: |
|
||||
Controls when the humanoid's health bar is allowed to be displayed.
|
||||
|
|
@ -543,7 +543,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.HipHeight
|
||||
summary: |
|
||||
Determines the distance off the ground the `Class.Humanoid.RootPart`
|
||||
|
|
@ -583,7 +583,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.Jump
|
||||
summary: |
|
||||
If `true`, the `Class.Humanoid` jumps with an upwards force.
|
||||
|
|
@ -606,7 +606,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.JumpHeight
|
||||
summary: |
|
||||
|
|
@ -638,7 +638,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.JumpPower
|
||||
summary: |
|
||||
|
|
@ -674,7 +674,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.LeftLeg
|
||||
summary: |
|
||||
|
|
@ -700,7 +700,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.MaxHealth
|
||||
summary: |
|
||||
The maximum value of a humanoid's `Class.Humanoid.Health|Health`.
|
||||
|
|
@ -726,7 +726,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.maxHealth
|
||||
summary: ''
|
||||
|
|
@ -748,7 +748,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.MaxSlopeAngle
|
||||
summary: |
|
||||
The maximum slope angle that a humanoid can walk on without slipping.
|
||||
|
|
@ -777,7 +777,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.MoveDirection
|
||||
summary: |
|
||||
|
|
@ -805,7 +805,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.NameDisplayDistance
|
||||
summary: |
|
||||
|
|
@ -833,7 +833,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.NameOcclusion
|
||||
summary: |
|
||||
Controls whether a humanoid's name and health bar can be seen behind walls
|
||||
|
|
@ -866,7 +866,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.PlatformStand
|
||||
summary: |
|
||||
Determines whether the `Class.Humanoid` is currently in the
|
||||
|
|
@ -890,7 +890,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.RequiresNeck
|
||||
summary: |
|
||||
|
|
@ -914,7 +914,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.RightLeg
|
||||
summary: |
|
||||
|
|
@ -940,7 +940,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.RigType
|
||||
summary: |
|
||||
Describes whether this `Class.Humanoid` is utilizing the legacy R6
|
||||
|
|
@ -970,7 +970,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.RootPart
|
||||
summary: |
|
||||
A reference to the humanoid's **HumanoidRootPart** object.
|
||||
|
|
@ -998,7 +998,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.SeatPart
|
||||
summary: |
|
||||
|
|
@ -1029,7 +1029,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Sit
|
||||
summary: |
|
||||
|
|
@ -1061,7 +1061,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.TargetPoint
|
||||
summary: |
|
||||
|
|
@ -1093,7 +1093,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Torso
|
||||
summary: |
|
||||
|
|
@ -1120,7 +1120,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.UseJumpPower
|
||||
summary: |
|
||||
Determines whether the `Class.Humanoid.JumpHeight|JumpHeight` (false) or
|
||||
|
|
@ -1146,7 +1146,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.WalkSpeed
|
||||
summary: |
|
||||
|
|
@ -1187,7 +1187,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.WalkToPart
|
||||
summary: |
|
||||
|
|
@ -1224,7 +1224,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.WalkToPoint
|
||||
summary: |
|
||||
|
|
@ -1256,7 +1256,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
methods:
|
||||
- name: Humanoid:AddAccessory
|
||||
|
|
@ -1300,7 +1300,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:AddCustomStatus
|
||||
summary: |
|
||||
Adds a custom status to the Humanoid.
|
||||
|
|
@ -1326,7 +1326,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:AddStatus
|
||||
summary: |
|
||||
Adds a BoolValue to the Humanoid's _Status_ object.
|
||||
|
|
@ -1352,7 +1352,38 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:ApplyDescription
|
||||
summary: |
|
||||
Makes the character's look match that of the passed in
|
||||
`Class.HumanoidDescription`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
The `Class.HumanoidDescription` instance which you want to set the
|
||||
character to match.
|
||||
- name: assetTypeVerification
|
||||
type: AssetTypeVerification
|
||||
default: Default
|
||||
summary: |
|
||||
The asset type verification mode.
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Humanoid:ApplyDescriptionAsync()|ApplyDescriptionAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:ApplyDescriptionAsync
|
||||
summary: |
|
||||
Makes the character's look match that of the passed in
|
||||
|
|
@ -1406,11 +1437,11 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- name: Humanoid:ApplyDescription
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:ApplyDescriptionReset
|
||||
summary: |
|
||||
Makes the character's look match that of the passed in
|
||||
`Class.HumanoidDescription`.
|
||||
`Class.HumanoidDescription`, even after external changes.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
|
|
@ -1433,11 +1464,11 @@ methods:
|
|||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Humanoid:ApplyDescriptionAsync()|ApplyDescriptionAsync()`.
|
||||
`Class.Humanoid:ApplyDescriptionResetAsync()|ApplyDescriptionResetAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:ApplyDescriptionResetAsync
|
||||
summary: |
|
||||
Makes the character's look match that of the passed in
|
||||
|
|
@ -1481,38 +1512,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- name: Humanoid:ApplyDescriptionReset
|
||||
summary: |
|
||||
Makes the character's look match that of the passed in
|
||||
`Class.HumanoidDescription`, even after external changes.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
The `Class.HumanoidDescription` instance which you want to set the
|
||||
character to match.
|
||||
- name: assetTypeVerification
|
||||
type: AssetTypeVerification
|
||||
default: Default
|
||||
summary: |
|
||||
The asset type verification mode.
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Humanoid:ApplyDescriptionResetAsync()|ApplyDescriptionResetAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:BuildRigFromAttachments
|
||||
summary: |
|
||||
Assembles a tree of `Class.Motor6D` joints by attaching together
|
||||
|
|
@ -1544,7 +1544,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:ChangeState
|
||||
summary: |
|
||||
|
|
@ -1595,7 +1595,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:EquipTool
|
||||
summary: |
|
||||
|
|
@ -1626,7 +1626,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:GetAccessories
|
||||
summary: |
|
||||
|
|
@ -1655,7 +1655,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:GetAppliedDescription
|
||||
summary: |
|
||||
Returns a copy of the humanoid's cached `Class.HumanoidDescription` which
|
||||
|
|
@ -1687,7 +1687,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:GetBodyPartR15
|
||||
summary: |
|
||||
Pass a body part to this method (the body part should be a sibling of
|
||||
|
|
@ -1726,7 +1726,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:GetLimb
|
||||
summary: |
|
||||
|
|
@ -1766,7 +1766,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:GetMoveVelocity
|
||||
summary: ''
|
||||
|
|
@ -1781,7 +1781,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:GetPlayingAnimationTracks
|
||||
summary: |
|
||||
|
|
@ -1809,7 +1809,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:GetState
|
||||
summary: |
|
||||
Returns the humanoid's current `Enum.HumanoidStateType`.
|
||||
|
|
@ -1833,7 +1833,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Safe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:GetStateEnabled
|
||||
summary: |
|
||||
|
|
@ -1873,7 +1873,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Safe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:GetStatuses
|
||||
summary: |
|
||||
|
|
@ -1895,7 +1895,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:HasCustomStatus
|
||||
summary: |
|
||||
Returns boolean based on if custom statuses exist.
|
||||
|
|
@ -1920,7 +1920,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:HasStatus
|
||||
summary: |
|
||||
Returns a boolean based on if a status exists.
|
||||
|
|
@ -1944,7 +1944,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:LoadAnimation
|
||||
summary: |
|
||||
Loads an `Class.Animation` onto a `Class.Humanoid`, returning an
|
||||
|
|
@ -1971,7 +1971,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:loadAnimation
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -1992,7 +1992,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:Move
|
||||
summary: |
|
||||
Causes the `Class.Humanoid` to walk in the given direction.
|
||||
|
|
@ -2046,7 +2046,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:MoveTo
|
||||
summary: |
|
||||
|
|
@ -2107,33 +2107,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:PlayEmoteAsync
|
||||
summary: |
|
||||
Plays emotes and returns if was successfully ran.
|
||||
description: |
|
||||
If the emote could not be played because the emoteName is not found in the
|
||||
HumanoidDescription, this method will give an error. The method will
|
||||
return true to indicate that the emote was played successfully.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: emoteName
|
||||
type: string
|
||||
default:
|
||||
summary: |
|
||||
name of the emote to play.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
successfully played.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:PlayEmote
|
||||
summary: |
|
||||
|
|
@ -2159,7 +2133,33 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:PlayEmoteAsync
|
||||
summary: |
|
||||
Plays emotes and returns if was successfully ran.
|
||||
description: |
|
||||
If the emote could not be played because the emoteName is not found in the
|
||||
HumanoidDescription, this method will give an error. The method will
|
||||
return true to indicate that the emote was played successfully.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: emoteName
|
||||
type: string
|
||||
default:
|
||||
summary: |
|
||||
name of the emote to play.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
successfully played.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:RemoveAccessories
|
||||
summary: |
|
||||
|
|
@ -2188,7 +2188,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:RemoveCustomStatus
|
||||
summary: |
|
||||
Removes the defined custom status from the Status model in the Humanoid..
|
||||
|
|
@ -2213,7 +2213,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:RemoveStatus
|
||||
summary: |
|
||||
Removes the defined status from the Status model in the Humanoid.
|
||||
|
|
@ -2238,7 +2238,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:ReplaceBodyPartR15
|
||||
summary: |
|
||||
Dynamically replaces a Humanoid body part with a different part.
|
||||
|
|
@ -2274,7 +2274,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:SetStateEnabled
|
||||
summary: |
|
||||
Sets whether a given `Enum.HumanoidStateType` is enabled for the
|
||||
|
|
@ -2310,7 +2310,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:TakeDamage
|
||||
summary: |
|
||||
|
|
@ -2358,7 +2358,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid:takeDamage
|
||||
summary: ''
|
||||
|
|
@ -2380,7 +2380,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid:UnequipTools
|
||||
summary: |
|
||||
Unequips any `Class.Tool` currently equipped by the `Class.Humanoid`.
|
||||
|
|
@ -2408,7 +2408,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
events:
|
||||
- name: Humanoid.AnimationPlayed
|
||||
|
|
@ -2445,7 +2445,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.ApplyDescriptionFinished
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -2459,7 +2459,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.Climbing
|
||||
summary: |
|
||||
Fires when the speed at which a `Class.Humanoid` is climbing changes.
|
||||
|
|
@ -2495,7 +2495,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.CustomStatusAdded
|
||||
summary: |
|
||||
|
|
@ -2517,7 +2517,7 @@ events:
|
|||
not use it for new work.
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.CustomStatusRemoved
|
||||
summary: |
|
||||
Fired when a status is removed from the Humanoid.
|
||||
|
|
@ -2538,7 +2538,7 @@ events:
|
|||
not use it for new work.
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.Died
|
||||
summary: |
|
||||
Fires when the `Class.Humanoid` dies.
|
||||
|
|
@ -2558,7 +2558,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.FallingDown
|
||||
summary: |
|
||||
|
|
@ -2584,7 +2584,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.FreeFalling
|
||||
summary: |
|
||||
|
|
@ -2614,7 +2614,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.GettingUp
|
||||
summary: |
|
||||
|
|
@ -2646,7 +2646,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.HealthChanged
|
||||
summary: |
|
||||
|
|
@ -2673,7 +2673,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Jumping
|
||||
summary: |
|
||||
|
|
@ -2703,7 +2703,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.MoveToFinished
|
||||
summary: |
|
||||
|
|
@ -2737,7 +2737,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.PlatformStanding
|
||||
summary: |
|
||||
|
|
@ -2769,7 +2769,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Ragdoll
|
||||
summary: |
|
||||
|
|
@ -2801,7 +2801,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Running
|
||||
summary: |
|
||||
|
|
@ -2834,7 +2834,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Seated
|
||||
summary: |
|
||||
|
|
@ -2876,7 +2876,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.StateChanged
|
||||
summary: |
|
||||
|
|
@ -2914,7 +2914,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.StateEnabledChanged
|
||||
summary: |
|
||||
|
|
@ -2951,7 +2951,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.StatusAdded
|
||||
summary: |
|
||||
|
|
@ -2973,7 +2973,7 @@ events:
|
|||
not use it for new work.
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.StatusRemoved
|
||||
summary: |
|
||||
Fired when a status is removed from the Humanoid.
|
||||
|
|
@ -2994,7 +2994,7 @@ events:
|
|||
not use it for new work.
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: Humanoid.Strafing
|
||||
summary: |
|
||||
Fires when the `Class.Humanoid` enters or leaves the `StrafingNoPhysics`
|
||||
|
|
@ -3028,7 +3028,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Swimming
|
||||
summary: |
|
||||
|
|
@ -3063,7 +3063,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
- name: Humanoid.Touched
|
||||
summary: |
|
||||
|
|
@ -3116,6 +3116,6 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- AvatarBehavior
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -67,7 +67,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.BackAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -109,7 +109,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.BodyTypeScale
|
||||
summary: |
|
||||
Determines the factor by which the shape of a `Class.Humanoid` is
|
||||
|
|
@ -152,7 +152,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.ClimbAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -187,7 +187,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.DepthScale
|
||||
summary: |
|
||||
Determines by what factor the depth (back-to-front distance) of a
|
||||
|
|
@ -221,7 +221,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.Face
|
||||
summary: |
|
||||
Determines the asset ID of the Face to be applied to the `Class.Humanoid`.
|
||||
|
|
@ -259,7 +259,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.FaceAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -304,7 +304,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.FallAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -341,7 +341,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.FrontAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -384,7 +384,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.GraphicTShirt
|
||||
summary: |
|
||||
Determines the `Class.ShirtGraphic.Graphic|Graphic` used by a
|
||||
|
|
@ -417,7 +417,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.HairAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -459,7 +459,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.HatAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -501,7 +501,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.Head
|
||||
summary: |
|
||||
Determines the asset ID of the Head to be applied to the `Class.Humanoid`.
|
||||
|
|
@ -539,7 +539,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.HeadColor
|
||||
summary: |
|
||||
Determines the `Class.BodyColors.HeadColor3` and
|
||||
|
|
@ -578,7 +578,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.HeadScale
|
||||
summary: |
|
||||
Determines by what factor the **Head** object of a `Class.Humanoid` is
|
||||
|
|
@ -617,7 +617,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.HeightScale
|
||||
summary: |
|
||||
Determines by what factor the height (top-to-bottom distance) of a
|
||||
|
|
@ -652,7 +652,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.IdleAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -690,7 +690,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.JumpAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -727,7 +727,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.LeftArm
|
||||
summary: |
|
||||
Determines the asset ID of the LeftArm to be applied to the
|
||||
|
|
@ -762,7 +762,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.LeftArmColor
|
||||
summary: |
|
||||
Determines the `Class.BodyColors.LeftArmColor3` and
|
||||
|
|
@ -802,7 +802,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.LeftLeg
|
||||
summary: |
|
||||
Determines the asset ID of the LeftLeg to be applied to the
|
||||
|
|
@ -837,7 +837,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.LeftLegColor
|
||||
summary: |
|
||||
Determines the `Class.BodyColors.LeftLegColor3` and
|
||||
|
|
@ -877,7 +877,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.MoodAnimation
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -894,7 +894,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.NeckAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -941,7 +941,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.Pants
|
||||
summary: |
|
||||
Determines the `Class.Pants.PantsTemplate|PantsTemplate` used by a
|
||||
|
|
@ -975,7 +975,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.ProportionScale
|
||||
summary: |
|
||||
Determines how wide (0) or narrow (1) a `Class.Humanoid` rig is.
|
||||
|
|
@ -1015,7 +1015,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.RightArm
|
||||
summary: |
|
||||
Determines the asset ID of the RightArm to be applied to the
|
||||
|
|
@ -1050,7 +1050,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.RightArmColor
|
||||
summary: |
|
||||
Determines the `Class.BodyColors.RightArmColor3` and
|
||||
|
|
@ -1090,7 +1090,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.RightLeg
|
||||
summary: |
|
||||
Determines the asset ID of the RightLeg to be applied to the
|
||||
|
|
@ -1125,7 +1125,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.RightLegColor
|
||||
summary: |
|
||||
Determines the `Class.BodyColors.RightLegColor3` and
|
||||
|
|
@ -1165,7 +1165,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.RunAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -1203,7 +1203,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.Shirt
|
||||
summary: |
|
||||
Determines the `Class.Shirt.ShirtTemplate|ShirtTemplate` used by a
|
||||
|
|
@ -1239,7 +1239,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.ShouldersAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -1282,7 +1282,24 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.StaticFacialAnimation
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Animation
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.SwimAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -1319,7 +1336,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.Torso
|
||||
summary: |
|
||||
Determines the asset ID of the Torso to be applied to the
|
||||
|
|
@ -1354,7 +1371,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.TorsoColor
|
||||
summary: |
|
||||
Determines the `Class.BodyColors.TorsoColor3` and
|
||||
|
|
@ -1395,7 +1412,24 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.UseAvatarSettings
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.WaistAccessory
|
||||
summary: |
|
||||
A comma-separated list of asset IDs that will be added as
|
||||
|
|
@ -1437,7 +1471,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.WalkAnimation
|
||||
summary: |
|
||||
When this description is `Class.Humanoid:ApplyDescriptionAsync()|applied`
|
||||
|
|
@ -1475,7 +1509,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.WidthScale
|
||||
summary: |
|
||||
Determines by what factor the width (left-to-right distance) of a
|
||||
|
|
@ -1510,7 +1544,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods:
|
||||
- name: HumanoidDescription:AddEmote
|
||||
summary: |
|
||||
|
|
@ -1559,7 +1593,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:GetAccessories
|
||||
summary: |
|
||||
Returns a table of an avatar's current accessories.
|
||||
|
|
@ -1588,7 +1622,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:GetEmotes
|
||||
summary: |
|
||||
Returns a dictionary of emotes that have been
|
||||
|
|
@ -1646,7 +1680,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:GetEquippedEmotes
|
||||
summary: |
|
||||
Returns an array of tables describing the equipped emotes that have been
|
||||
|
|
@ -1699,7 +1733,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:RemoveEmote
|
||||
summary: |
|
||||
Removes any emotes that have been added under the given name.
|
||||
|
|
@ -1736,7 +1770,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:SetAccessories
|
||||
summary: |
|
||||
Accepts a table that sets the accessories and related properties for an
|
||||
|
|
@ -1771,7 +1805,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:SetEmotes
|
||||
summary: |
|
||||
Sets all of the emotes on this description.
|
||||
|
|
@ -1828,7 +1862,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription:SetEquippedEmotes
|
||||
summary: |
|
||||
Sets the currently equipped emotes given an array of emote names.
|
||||
|
|
@ -1893,7 +1927,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
events:
|
||||
- name: HumanoidDescription.EmotesChanged
|
||||
summary: |
|
||||
|
|
@ -1939,7 +1973,7 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: HumanoidDescription.EquippedEmotesChanged
|
||||
summary: |
|
||||
Fires when the equipped emotes are
|
||||
|
|
@ -1995,5 +2029,5 @@ events:
|
|||
deprecation_message: ''
|
||||
security: None
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -45,6 +45,23 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Input
|
||||
- name: InputBinding.ClampMagnitudeToOne
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Composite Directions
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Input
|
||||
- name: InputBinding.Down
|
||||
summary: |
|
||||
Specifies an alternate `Enum.KeyCode` for dispatching directionally "down"
|
||||
|
|
@ -174,6 +191,23 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Input
|
||||
- name: InputBinding.PointerIndex
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: int
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Behavior
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Input
|
||||
- name: InputBinding.PressedThreshold
|
||||
summary: |
|
||||
Numerical value above which to fire an `Class.InputAction` with a
|
||||
|
|
|
|||
|
|
@ -210,6 +210,35 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: InsertService:GetFreeDecals
|
||||
summary: |
|
||||
Retrieves a list of free Decals from the Catalog.
|
||||
description: ''
|
||||
code_samples:
|
||||
- InsertService-GetFreeDecals1
|
||||
parameters:
|
||||
- name: searchText
|
||||
type: string
|
||||
default:
|
||||
summary: |
|
||||
String used to search for free decals in the Catalog.
|
||||
- name: pageNum
|
||||
type: int
|
||||
default:
|
||||
summary: |
|
||||
The page number in the Catalog to return.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A single table (of returned free decals) wrapped in a table.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: InsertService:GetFreeDecalsAsync
|
||||
summary: |
|
||||
Retrieves a list of free Decals from the Catalog.
|
||||
|
|
@ -268,12 +297,12 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: InsertService:GetFreeDecals
|
||||
- name: InsertService:GetFreeModels
|
||||
summary: |
|
||||
Retrieves a list of free Decals from the Catalog.
|
||||
Retrieves a list of Free Models from the Catalog.
|
||||
description: ''
|
||||
code_samples:
|
||||
- InsertService-GetFreeDecals1
|
||||
- InsertService-GetFreeModels1
|
||||
parameters:
|
||||
- name: searchText
|
||||
type: string
|
||||
|
|
@ -288,7 +317,7 @@ methods:
|
|||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A single table (of returned free decals) wrapped in a table.
|
||||
A single table (of returned free models) wrapped in a table.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -353,35 +382,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: InsertService:GetFreeModels
|
||||
summary: |
|
||||
Retrieves a list of Free Models from the Catalog.
|
||||
description: ''
|
||||
code_samples:
|
||||
- InsertService-GetFreeModels1
|
||||
parameters:
|
||||
- name: searchText
|
||||
type: string
|
||||
default:
|
||||
summary: |
|
||||
String used to search for free decals in the Catalog.
|
||||
- name: pageNum
|
||||
type: int
|
||||
default:
|
||||
summary: |
|
||||
The page number in the Catalog to return.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A single table (of returned free models) wrapped in a table.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: InsertService:GetLatestAssetVersionAsync
|
||||
summary: |
|
||||
Returns the latest AssetVersionId of an asset for assets created by the
|
||||
|
|
|
|||
|
|
@ -30,6 +30,7 @@ descendants:
|
|||
- AnimationClipProvider
|
||||
- AnimationController
|
||||
- AnimationFromVideoCreatorService
|
||||
- AnimationNodeDefinition
|
||||
- AnimationRigData
|
||||
- AnimationTrack
|
||||
- Animator
|
||||
|
|
@ -67,6 +68,7 @@ descendants:
|
|||
- AvatarEditorService
|
||||
- Backpack
|
||||
- BadgeService
|
||||
- BaseCoreGuiConfiguration
|
||||
- BasePlayerGui
|
||||
- BaseRemoteEvent
|
||||
- BaseWrap
|
||||
|
|
@ -96,6 +98,7 @@ descendants:
|
|||
- ControllerManager
|
||||
- ControllerService
|
||||
- CookiesService
|
||||
- CoreGuiConfiguration
|
||||
- CustomEvent
|
||||
- CustomEventReceiver
|
||||
- CustomLog
|
||||
|
|
@ -143,7 +146,6 @@ descendants:
|
|||
- GuiBase
|
||||
- GuiService
|
||||
- GuidRegistryService
|
||||
- HandRigDescription
|
||||
- HapticEffect
|
||||
- HapticService
|
||||
- HeapProfilerService
|
||||
|
|
@ -177,6 +179,7 @@ descendants:
|
|||
- LuaSourceContainer
|
||||
- LuaWebService
|
||||
- MLService
|
||||
- MakeupDescription
|
||||
- MarkerCurve
|
||||
- MarketplaceService
|
||||
- MatchmakingService
|
||||
|
|
@ -371,7 +374,9 @@ descendants:
|
|||
- StyleDerive
|
||||
- StyleLink
|
||||
- Annotation
|
||||
- RemoteCommandService
|
||||
- ServiceVisibilityService
|
||||
- UniqueIdLookupService
|
||||
- GetTextBoundsParams
|
||||
tags:
|
||||
- NotCreatable
|
||||
|
|
|
|||
|
|
@ -34,6 +34,31 @@ deprecation_message: |
|
|||
instead.
|
||||
properties: []
|
||||
methods:
|
||||
- name: KeyframeSequenceProvider:GetAnimations
|
||||
summary: |
|
||||
This function returns an `Class.InventoryPages` object which can be used
|
||||
to iterate over animations owned by a specific user.
|
||||
description: ''
|
||||
code_samples:
|
||||
- KeyframeSequenceProvider-GetAnimations
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The user ID of the user.
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: |
|
||||
An `Class.InventoryPages` of animations.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: KeyframeSequenceProvider:GetAnimationsAsync
|
||||
summary: |
|
||||
This function returns an `Class.InventoryPages` object which can be used
|
||||
|
|
@ -63,31 +88,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: KeyframeSequenceProvider:GetAnimations
|
||||
summary: |
|
||||
This function returns an `Class.InventoryPages` object which can be used
|
||||
to iterate over animations owned by a specific user.
|
||||
description: ''
|
||||
code_samples:
|
||||
- KeyframeSequenceProvider-GetAnimations
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The user ID of the user.
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: |
|
||||
An `Class.InventoryPages` of animations.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Animation
|
||||
- name: KeyframeSequenceProvider:GetKeyframeSequence
|
||||
summary: |
|
||||
Returns a `Class.KeyframeSequence` from a given asset URL.
|
||||
|
|
|
|||
|
|
@ -0,0 +1,102 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: MakeupDescription
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags:
|
||||
- NotBrowsable
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: MakeupDescription.AssetId
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: int64
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: MakeupDescription.Instance
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: MakeupDescription.MakeupType
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: MakeupType
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- name: MakeupDescription.Order
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: int
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
methods:
|
||||
- name: MakeupDescription:GetAppliedInstance
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -60,6 +60,39 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:GetProductInfo
|
||||
summary: |
|
||||
Returns the product information of an asset using its asset ID.
|
||||
description: ''
|
||||
code_samples:
|
||||
- MarketplaceService-GetProductInfo1
|
||||
parameters:
|
||||
- name: assetId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The asset ID of the specified product.
|
||||
- name: infoType
|
||||
type: InfoType
|
||||
default: Asset
|
||||
summary: |
|
||||
An `Enum.InfoType` enum value specifying the type of information being
|
||||
retrieved.
|
||||
returns:
|
||||
- type: Dictionary
|
||||
summary: |
|
||||
A dictionary containing information about the queried item, described
|
||||
in the previous tables.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.MarketplaceService.GetProductInfoAsync|GetProductInfoAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:GetProductInfoAsync
|
||||
summary: |
|
||||
Returns the product information of an asset using its asset ID.
|
||||
|
|
@ -349,39 +382,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:GetProductInfo
|
||||
summary: |
|
||||
Returns the product information of an asset using its asset ID.
|
||||
description: ''
|
||||
code_samples:
|
||||
- MarketplaceService-GetProductInfo1
|
||||
parameters:
|
||||
- name: assetId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The asset ID of the specified product.
|
||||
- name: infoType
|
||||
type: InfoType
|
||||
default: Asset
|
||||
summary: |
|
||||
An `Enum.InfoType` enum value specifying the type of information being
|
||||
retrieved.
|
||||
returns:
|
||||
- type: Dictionary
|
||||
summary: |
|
||||
A dictionary containing information about the queried item, described
|
||||
in the previous tables.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.MarketplaceService.GetProductInfoAsync|GetProductInfoAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:GetSubscriptionProductInfoAsync
|
||||
summary: |
|
||||
Returns the product information of a subscription for the given
|
||||
|
|
@ -778,6 +778,38 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: MarketplaceService:PlayerOwnsAsset
|
||||
summary: |
|
||||
Returns whether the given user has the given asset.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: player
|
||||
type: Instance
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player` whose inventory is tested for ownership of the
|
||||
given asset.
|
||||
- name: assetId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The asset ID for which the given player's inventory is tested.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
Indicates whether the given player's inventory contains the given
|
||||
asset.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.MarketplaceService:PlayerOwnsAssetAsync()|PlayerOwnsAssetAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:PlayerOwnsAssetAsync
|
||||
summary: |
|
||||
Returns whether the given user has the given asset.
|
||||
|
|
@ -823,34 +855,34 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:PlayerOwnsAsset
|
||||
- name: MarketplaceService:PlayerOwnsBundle
|
||||
summary: |
|
||||
Returns whether the given user has the given asset.
|
||||
Returns whether the given player owns the given bundle.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: player
|
||||
type: Instance
|
||||
type: Player
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player` whose inventory is tested for ownership of the
|
||||
given asset.
|
||||
- name: assetId
|
||||
given bundle.
|
||||
- name: bundleId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The asset ID for which the given player's inventory is tested.
|
||||
The bundle ID for which the given player's inventory is tested.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
Indicates whether the given player's inventory contains the given
|
||||
asset.
|
||||
bundle.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.MarketplaceService:PlayerOwnsAssetAsync()|PlayerOwnsAssetAsync()`.
|
||||
`Class.MarketplaceService:PlayerOwnsBundleAsync()|PlayerOwnsBundleAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
|
|
@ -888,38 +920,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:PlayerOwnsBundle
|
||||
summary: |
|
||||
Returns whether the given player owns the given bundle.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: player
|
||||
type: Player
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player` whose inventory is tested for ownership of the
|
||||
given bundle.
|
||||
- name: bundleId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The bundle ID for which the given player's inventory is tested.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
Indicates whether the given player's inventory contains the given
|
||||
bundle.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.MarketplaceService:PlayerOwnsBundleAsync()|PlayerOwnsBundleAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AssetRead
|
||||
- name: MarketplaceService:PromptBulkPurchase
|
||||
summary: |
|
||||
Prompts a user to purchase multiple avatar items with the given `assetId`
|
||||
|
|
@ -1299,7 +1299,8 @@ methods:
|
|||
description: |
|
||||
Returns true if the user with the given `Class.Player.UserId|UserId` owns
|
||||
the [pass](../../../production/monetization/passes.md) with the given
|
||||
`gamePassId` (not to be confused with an asset ID).
|
||||
`gamePassId` (not to be confused with an asset ID). You can use this
|
||||
method on both the client and the server.
|
||||
|
||||
#### Caching Behavior
|
||||
|
||||
|
|
|
|||
|
|
@ -66,7 +66,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -1153,6 +1153,34 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:GetFriendsOnline
|
||||
summary: |
|
||||
Returns a dictionary of online connections. Returns the product
|
||||
information of an asset using its asset ID.
|
||||
description: ''
|
||||
code_samples:
|
||||
- how-to-get-a-list-of-online-friends
|
||||
parameters:
|
||||
- name: maxFriends
|
||||
type: int
|
||||
default: 200
|
||||
summary: |
|
||||
The maximum number of online connections to return.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A dictionary of online connections (see the table above).
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Player:GetFriendsOnlineAsync()|GetFriendsOnlineAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Social
|
||||
- name: Player:GetFriendsOnlineAsync
|
||||
summary: |
|
||||
Returns a dictionary of online connections.
|
||||
|
|
@ -1238,34 +1266,6 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- Social
|
||||
- name: Player:GetFriendsOnline
|
||||
summary: |
|
||||
Returns a dictionary of online connections. Returns the product
|
||||
information of an asset using its asset ID.
|
||||
description: ''
|
||||
code_samples:
|
||||
- how-to-get-a-list-of-online-friends
|
||||
parameters:
|
||||
- name: maxFriends
|
||||
type: int
|
||||
default: 200
|
||||
summary: |
|
||||
The maximum number of online connections to return.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A dictionary of online connections (see the table above).
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Player:GetFriendsOnlineAsync()|GetFriendsOnlineAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Social
|
||||
- name: Player:GetJoinData
|
||||
summary: |
|
||||
Returns a dictionary containing information describing how the player
|
||||
|
|
@ -1419,6 +1419,31 @@ methods:
|
|||
thread_safety: Safe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:GetRankInGroup
|
||||
summary: |
|
||||
Returns the player's rank in the group as an integer.
|
||||
description: ''
|
||||
code_samples:
|
||||
- Player-GetRankInGroup1
|
||||
parameters:
|
||||
- name: groupId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `groupId` of the specified group.
|
||||
returns:
|
||||
- type: int
|
||||
summary: |
|
||||
The player's rank in the group.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:GetRankInGroupAsync
|
||||
summary: |
|
||||
Returns the player's rank in the group as an integer.
|
||||
|
|
@ -1458,26 +1483,30 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:GetRankInGroup
|
||||
- name: Player:GetRoleInGroup
|
||||
summary: |
|
||||
Returns the player's rank in the group as an integer.
|
||||
Returns the player's role in the group as a string, or `Guest` if the
|
||||
player isn't part of the group.
|
||||
description: ''
|
||||
code_samples:
|
||||
- Player-GetRankInGroup1
|
||||
- Player-GetRoleInGroup1
|
||||
parameters:
|
||||
- name: groupId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `groupId` of the specified group.
|
||||
The group ID of the specified group.
|
||||
returns:
|
||||
- type: int
|
||||
- type: string
|
||||
summary: |
|
||||
The player's rank in the group.
|
||||
The player's role in the specified group, or `Guest` if the player is
|
||||
not a member.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Player.GetRoleInGroupAsync|GetRoleInGroup()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
|
|
@ -1524,35 +1553,6 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:GetRoleInGroup
|
||||
summary: |
|
||||
Returns the player's role in the group as a string, or `Guest` if the
|
||||
player isn't part of the group.
|
||||
description: ''
|
||||
code_samples:
|
||||
- Player-GetRoleInGroup1
|
||||
parameters:
|
||||
- name: groupId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The group ID of the specified group.
|
||||
returns:
|
||||
- type: string
|
||||
summary: |
|
||||
The player's role in the specified group, or `Guest` if the player is
|
||||
not a member.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Player.GetRoleInGroupAsync|GetRoleInGroup()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:HasAppearanceLoaded
|
||||
summary: |
|
||||
Returns whether or not the appearance of the player's character has
|
||||
|
|
@ -1605,35 +1605,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:IsFriendsWithAsync
|
||||
summary: |
|
||||
Checks whether a player is a connection of the user with the given
|
||||
`Class.Player.UserId`.
|
||||
description: |
|
||||
This method sends a request to Roblox asking whether a player is a
|
||||
connection of another user, given the `Class.Player.UserId|UserId` of that
|
||||
user. This method caches results so multiple calls on the same player with
|
||||
the same `userId` may not yield the most up-to-date result.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player.UserId` of the specified player.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
A boolean indicating whether a player is a connection of the specified
|
||||
user.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Social
|
||||
- name: Player:IsFriendsWith
|
||||
summary: |
|
||||
Checks whether a player is a connection of the user with the given
|
||||
|
|
@ -1684,6 +1655,61 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:IsFriendsWithAsync
|
||||
summary: |
|
||||
Checks whether a player is a connection of the user with the given
|
||||
`Class.Player.UserId`.
|
||||
description: |
|
||||
This method sends a request to Roblox asking whether a player is a
|
||||
connection of another user, given the `Class.Player.UserId|UserId` of that
|
||||
user. This method caches results so multiple calls on the same player with
|
||||
the same `userId` may not yield the most up-to-date result.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Class.Player.UserId` of the specified player.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
A boolean indicating whether a player is a connection of the specified
|
||||
user.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Social
|
||||
- name: Player:IsInGroup
|
||||
summary: |
|
||||
Checks whether a player is a member of a group with the given ID.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: groupId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The group ID of the specified group.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
A boolean indicating whether the player is in the specified group.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Player.IsInGroupAsync|IsInGroupAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:IsInGroupAsync
|
||||
summary: |
|
||||
Checks whether a player is a member of a group with the given ID.
|
||||
|
|
@ -1722,32 +1748,6 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:IsInGroup
|
||||
summary: |
|
||||
Checks whether a player is a member of a group with the given ID.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: groupId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The group ID of the specified group.
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: |
|
||||
A boolean indicating whether the player is in the specified group.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Player.IsInGroupAsync|IsInGroupAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- Groups
|
||||
- name: Player:IsVerified
|
||||
summary: |
|
||||
Returns whether the player is verified with concrete, real-world signals.
|
||||
|
|
@ -1858,51 +1858,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:LoadCharacterAsync
|
||||
summary: |
|
||||
Creates a new character for the player, removing the old one. Also clears
|
||||
the player's `Class.Backpack` and `Class.PlayerGui`.
|
||||
description: |
|
||||
This method creates a new character for the player, removing the old one.
|
||||
It also clears the player's `Class.Backpack` and `Class.PlayerGui`. This
|
||||
is useful in cases where you want to reload the character without killing
|
||||
the player, such as when you want to load a new character appearance after
|
||||
changing the player's
|
||||
`Class.Player.CharacterAppearance|CharacterAppearance`.
|
||||
|
||||
After calling `LoadCharacterAsync()` for an individual player, it is not
|
||||
recommended to call it again for the same player until after that player's
|
||||
`Class.Player.CharacterAppearanceLoaded|CharacterAppearanceLoaded` event
|
||||
has fired.
|
||||
|
||||
#### Character Loading Event Order
|
||||
|
||||
Calling the `LoadCharacterAsync()` method on any `Player` fires events in
|
||||
the following order:
|
||||
|
||||
1. The character appearance initializes.
|
||||
2. The character rig builds and scales.
|
||||
3. The character moves to the spawn location.
|
||||
4. `Class.Player.Character` sets, automatically removing old character.
|
||||
5. `Class.Object.Changed` fires on the `Class.Player` with a value of
|
||||
`Character`.
|
||||
6. The character's `Class.Instance.Parent|Parent` sets to the
|
||||
`Class.DataModel`.
|
||||
7. `Class.Player.CharacterAdded` fires.
|
||||
8. `Class.Player.CharacterAppearanceLoaded` fires.
|
||||
code_samples:
|
||||
- Player-LoadCharacter1
|
||||
parameters: []
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:LoadCharacter
|
||||
summary: |
|
||||
Creates a new character for the player, removing the old one. Also clears
|
||||
|
|
@ -1967,35 +1922,43 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Player:LoadCharacterWithHumanoidDescriptionAsync
|
||||
- name: Player:LoadCharacterAsync
|
||||
summary: |
|
||||
Spawns a player character with everything equipped in the passed in
|
||||
`Class.HumanoidDescription`.
|
||||
Creates a new character for the player, removing the old one. Also clears
|
||||
the player's `Class.Backpack` and `Class.PlayerGui`.
|
||||
description: |
|
||||
This method spawns a player character with everything equipped in the
|
||||
passed in `Class.HumanoidDescription`.
|
||||
This method creates a new character for the player, removing the old one.
|
||||
It also clears the player's `Class.Backpack` and `Class.PlayerGui`. This
|
||||
is useful in cases where you want to reload the character without killing
|
||||
the player, such as when you want to load a new character appearance after
|
||||
changing the player's
|
||||
`Class.Player.CharacterAppearance|CharacterAppearance`.
|
||||
|
||||
After calling this method for an individual player, it is not recommended
|
||||
to call it again for the same player until after that player's
|
||||
After calling `LoadCharacterAsync()` for an individual player, it is not
|
||||
recommended to call it again for the same player until after that player's
|
||||
`Class.Player.CharacterAppearanceLoaded|CharacterAppearanceLoaded` event
|
||||
has fired.
|
||||
|
||||
See also
|
||||
[HumanoidDescription System](../../../characters/appearance.md#humanoiddescription),
|
||||
an article which explains the humanoid description system in greater
|
||||
detail and provides several scripting examples.
|
||||
#### Character Loading Event Order
|
||||
|
||||
Calling the `LoadCharacterAsync()` method on any `Player` fires events in
|
||||
the following order:
|
||||
|
||||
1. `Class.Player.Character` sets, automatically removing old character.
|
||||
2. `Class.Player.CharacterAdded` fires.
|
||||
3. `Class.Object.Changed` fires on the `Class.Player` with a value of
|
||||
`Character`.
|
||||
4. The character appearance initializes.
|
||||
5. `Class.Player.CharacterAppearanceLoaded` fires.
|
||||
6. The character's `Class.Instance.Parent|Parent` sets to the
|
||||
`Class.DataModel`.
|
||||
7. The character rig builds and scales.
|
||||
8. The character moves to the spawn location.
|
||||
code_samples:
|
||||
- spawn-characters-with-humanoiddescription
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
A `Class.HumanoidDescription` containing traits like body
|
||||
parts/colors, body scaling, accessories, clothing, and animations that
|
||||
will be equipped to the loaded character.
|
||||
- Player-LoadCharacter1
|
||||
parameters: []
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
|
|
@ -2034,6 +1997,43 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:LoadCharacterWithHumanoidDescriptionAsync
|
||||
summary: |
|
||||
Spawns a player character with everything equipped in the passed in
|
||||
`Class.HumanoidDescription`.
|
||||
description: |
|
||||
This method spawns a player character with everything equipped in the
|
||||
passed in `Class.HumanoidDescription`.
|
||||
|
||||
After calling this method for an individual player, it is not recommended
|
||||
to call it again for the same player until after that player's
|
||||
`Class.Player.CharacterAppearanceLoaded|CharacterAppearanceLoaded` event
|
||||
has fired.
|
||||
|
||||
See also
|
||||
[HumanoidDescription System](../../../characters/appearance.md#humanoiddescription),
|
||||
an article which explains the humanoid description system in greater
|
||||
detail and provides several scripting examples.
|
||||
code_samples:
|
||||
- spawn-characters-with-humanoiddescription
|
||||
parameters:
|
||||
- name: humanoidDescription
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
A `Class.HumanoidDescription` containing traits like body
|
||||
parts/colors, body scaling, accessories, clothing, and animations that
|
||||
will be equipped to the loaded character.
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Player:LoadInstance
|
||||
summary: |
|
||||
Returns an instance that was previously saved to the player with
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: PlayerListConfiguration
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- BaseCoreGuiConfiguration
|
||||
descendants: []
|
||||
tags:
|
||||
- NotCreatable
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: PlayerListConfiguration.Open
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: State
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -494,6 +494,43 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Players:CreateHumanoidModelFromDescription
|
||||
summary: |
|
||||
Returns a character `Class.Model` equipped with everything specified in
|
||||
the passed in `Class.HumanoidDescription`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: description
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
Specifies the appearance of the returned character.
|
||||
- name: rigType
|
||||
type: HumanoidRigType
|
||||
default:
|
||||
summary: |
|
||||
Specifies whether the returned character will be R6 or R15.
|
||||
- name: assetTypeVerification
|
||||
type: AssetTypeVerification
|
||||
default: Default
|
||||
summary: |
|
||||
The asset type verification mode.
|
||||
returns:
|
||||
- type: Model
|
||||
summary: |
|
||||
A `Class.Humanoid` character `Class.Model`.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Players:CreateHumanoidModelFromDescription()|CreateHumanoidModelFromDescription()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Players:CreateHumanoidModelFromDescriptionAsync
|
||||
summary: |
|
||||
Returns a character `Class.Model` equipped with everything specified in
|
||||
|
|
@ -530,72 +567,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- Players
|
||||
- name: Players:CreateHumanoidModelFromDescription
|
||||
summary: |
|
||||
Returns a character `Class.Model` equipped with everything specified in
|
||||
the passed in `Class.HumanoidDescription`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: description
|
||||
type: HumanoidDescription
|
||||
default:
|
||||
summary: |
|
||||
Specifies the appearance of the returned character.
|
||||
- name: rigType
|
||||
type: HumanoidRigType
|
||||
default:
|
||||
summary: |
|
||||
Specifies whether the returned character will be R6 or R15.
|
||||
- name: assetTypeVerification
|
||||
type: AssetTypeVerification
|
||||
default: Default
|
||||
summary: |
|
||||
The asset type verification mode.
|
||||
returns:
|
||||
- type: Model
|
||||
summary: |
|
||||
A `Class.Humanoid` character `Class.Model`.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Players:CreateHumanoidModelFromDescription()|CreateHumanoidModelFromDescription()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- Players
|
||||
- name: Players:CreateHumanoidModelFromUserIdAsync
|
||||
summary: |
|
||||
Returns a character Model set-up with everything equipped to match the
|
||||
avatar of the user specified by the passed in userId.
|
||||
description: |
|
||||
Returns a character Model set-up with everything equipped to match the
|
||||
avatar of the user specified by the passed in userId. This includes
|
||||
whether that character is currently R6 or R15.
|
||||
code_samples:
|
||||
- create-humanoid-model-from-userid
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The userId for a Roblox user. (The UserId is the number in the profile
|
||||
of the user e.g www.roblox.com/users/1/profile).
|
||||
returns:
|
||||
- type: Model
|
||||
summary: |
|
||||
A Humanoid character Model.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Players:CreateHumanoidModelFromUserId
|
||||
summary: |
|
||||
|
|
@ -625,6 +597,34 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Players:CreateHumanoidModelFromUserIdAsync
|
||||
summary: |
|
||||
Returns a character Model set-up with everything equipped to match the
|
||||
avatar of the user specified by the passed in userId.
|
||||
description: |
|
||||
Returns a character Model set-up with everything equipped to match the
|
||||
avatar of the user specified by the passed in userId. This includes
|
||||
whether that character is currently R6 or R15.
|
||||
code_samples:
|
||||
- create-humanoid-model-from-userid
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The userId for a Roblox user. (The UserId is the number in the profile
|
||||
of the user e.g www.roblox.com/users/1/profile).
|
||||
returns:
|
||||
- type: Model
|
||||
summary: |
|
||||
A Humanoid character Model.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Players
|
||||
- name: Players:GetBanHistoryAsync
|
||||
summary: |
|
||||
Retrieves the ban and unban history of any user within the experience's
|
||||
|
|
@ -874,6 +874,35 @@ methods:
|
|||
capabilities:
|
||||
- Players
|
||||
- Social
|
||||
- name: Players:GetHumanoidDescriptionFromOutfitId
|
||||
summary: |
|
||||
Returns the HumanoidDescription for a specified outfit, which will be set
|
||||
with the parts/colors/Animations etc of the outfit.
|
||||
description: ''
|
||||
code_samples:
|
||||
- get-humanoiddescription-from-outfitid
|
||||
parameters:
|
||||
- name: outfitId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The ID of the outfit for which the HumanoidDescription is sought.
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: |
|
||||
HumanoidDescription initialized with the specification for the passed
|
||||
in outfitId.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Players:GetHumanoidDescriptionFromOutfitIdAsync()|GetHumanoidDescriptionFromOutfitIdAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Players:GetHumanoidDescriptionFromOutfitIdAsync
|
||||
summary: |
|
||||
Returns the HumanoidDescription for a specified outfit, which will be set
|
||||
|
|
@ -902,66 +931,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- Players
|
||||
- name: Players:GetHumanoidDescriptionFromOutfitId
|
||||
summary: |
|
||||
Returns the HumanoidDescription for a specified outfit, which will be set
|
||||
with the parts/colors/Animations etc of the outfit.
|
||||
description: ''
|
||||
code_samples:
|
||||
- get-humanoiddescription-from-outfitid
|
||||
parameters:
|
||||
- name: outfitId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The ID of the outfit for which the HumanoidDescription is sought.
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: |
|
||||
HumanoidDescription initialized with the specification for the passed
|
||||
in outfitId.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Players:GetHumanoidDescriptionFromOutfitIdAsync()|GetHumanoidDescriptionFromOutfitIdAsync()`.
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- Players
|
||||
- name: Players:GetHumanoidDescriptionFromUserIdAsync
|
||||
summary: |
|
||||
Returns a HumanoidDescription which specifies everything equipped for the
|
||||
avatar of the user specified by the passed in userId.
|
||||
description: |
|
||||
Returns a HumanoidDescription which specifies everything equipped for the
|
||||
avatar of the user specified by the passed in userId. Also includes scales
|
||||
and body colors.
|
||||
code_samples:
|
||||
- get-humanoiddescription-from-userid
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The userId for a Roblox user. (The UserId is the number in the profile
|
||||
of the user e.g www.roblox.com/users/1/profile).
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: |
|
||||
HumanoidDescription initialized with the passed in user's avatar
|
||||
specification.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Players:GetHumanoidDescriptionFromUserId
|
||||
summary: |
|
||||
|
|
@ -991,7 +961,37 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Players:GetHumanoidDescriptionFromUserIdAsync
|
||||
summary: |
|
||||
Returns a HumanoidDescription which specifies everything equipped for the
|
||||
avatar of the user specified by the passed in userId.
|
||||
description: |
|
||||
Returns a HumanoidDescription which specifies everything equipped for the
|
||||
avatar of the user specified by the passed in userId. Also includes scales
|
||||
and body colors.
|
||||
code_samples:
|
||||
- get-humanoiddescription-from-userid
|
||||
parameters:
|
||||
- name: userId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The userId for a Roblox user. (The UserId is the number in the profile
|
||||
of the user e.g www.roblox.com/users/1/profile).
|
||||
returns:
|
||||
- type: HumanoidDescription
|
||||
summary: |
|
||||
HumanoidDescription initialized with the passed in user's avatar
|
||||
specification.
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- AvatarAppearance
|
||||
- Players
|
||||
- name: Players:GetNameFromUserIdAsync
|
||||
summary: |
|
||||
|
|
|
|||
|
|
@ -134,6 +134,37 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:CreateDockWidgetPluginGui
|
||||
summary: |
|
||||
Creates a `Class.DockWidgetPluginGui` given a
|
||||
`Datatype.DockWidgetPluginGuiInfo`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: pluginGuiId
|
||||
type: string
|
||||
default:
|
||||
summary: |
|
||||
A unique and consistent identifier used to storing the widget's dock
|
||||
state and other internal details.
|
||||
- name: dockWidgetPluginGuiInfo
|
||||
type: DockWidgetPluginGuiInfo
|
||||
default:
|
||||
summary: |
|
||||
Describes the `Class.DockWidgetPluginGui` to create (initial state,
|
||||
size, etc).
|
||||
returns:
|
||||
- type: DockWidgetPluginGui
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Plugin:CreateDockWidgetPluginGuiAsync()|CreateDockWidgetPluginGuiAsync()`.
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:CreateDockWidgetPluginGuiAsync
|
||||
summary: |
|
||||
Creates a `Class.DockWidgetPluginGui` given a
|
||||
|
|
@ -167,37 +198,6 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:CreateDockWidgetPluginGui
|
||||
summary: |
|
||||
Creates a `Class.DockWidgetPluginGui` given a
|
||||
`Datatype.DockWidgetPluginGuiInfo`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: pluginGuiId
|
||||
type: string
|
||||
default:
|
||||
summary: |
|
||||
A unique and consistent identifier used to storing the widget's dock
|
||||
state and other internal details.
|
||||
- name: dockWidgetPluginGuiInfo
|
||||
type: DockWidgetPluginGuiInfo
|
||||
default:
|
||||
summary: |
|
||||
Describes the `Class.DockWidgetPluginGui` to create (initial state,
|
||||
size, etc).
|
||||
returns:
|
||||
- type: DockWidgetPluginGui
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This method has been superseded by
|
||||
`Class.Plugin:CreateDockWidgetPluginGuiAsync()|CreateDockWidgetPluginGuiAsync()`.
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:CreatePluginAction
|
||||
summary: |
|
||||
Creates a `Class.PluginAction` which represents a generic performable
|
||||
|
|
@ -428,34 +428,6 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:ImportFbxAnimationAsync
|
||||
summary: |
|
||||
Prompts the user to open a `.fbx` animation file that can be loaded onto
|
||||
the `rigModel`, then proceeds to insert the animation as a
|
||||
`Class.KeyframeSequence` in the `Class.Workspace`.
|
||||
description: |
|
||||
This function prompts the user to open a `.fbx` animation file that can be
|
||||
loaded onto the `rigModel`, then proceeds to insert the animation as a
|
||||
`Class.KeyframeSequence` in the `Class.Workspace`.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: rigModel
|
||||
type: Instance
|
||||
default:
|
||||
summary: ''
|
||||
- name: isR15
|
||||
type: boolean
|
||||
default: true
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:ImportFbxAnimation
|
||||
summary: |
|
||||
Prompts the user to open a `.fbx` animation file that can be loaded onto
|
||||
|
|
@ -482,17 +454,21 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:ImportFbxRigAsync
|
||||
- name: Plugin:ImportFbxAnimationAsync
|
||||
summary: |
|
||||
Prompts the user to open a `.fbx` file, uploads the individual components
|
||||
of the model as meshes, and generates a character rig for use in
|
||||
animation, which is loaded into the `Class.Workspace`.
|
||||
Prompts the user to open a `.fbx` animation file that can be loaded onto
|
||||
the `rigModel`, then proceeds to insert the animation as a
|
||||
`Class.KeyframeSequence` in the `Class.Workspace`.
|
||||
description: |
|
||||
Prompts the user to open a `.fbx` file, uploads the individual components
|
||||
of the model as meshes, and generates a character rig for use in
|
||||
animation, which is loaded into the `Class.Workspace`.
|
||||
This function prompts the user to open a `.fbx` animation file that can be
|
||||
loaded onto the `rigModel`, then proceeds to insert the animation as a
|
||||
`Class.KeyframeSequence` in the `Class.Workspace`.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: rigModel
|
||||
type: Instance
|
||||
default:
|
||||
summary: ''
|
||||
- name: isR15
|
||||
type: boolean
|
||||
default: true
|
||||
|
|
@ -530,6 +506,30 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:ImportFbxRigAsync
|
||||
summary: |
|
||||
Prompts the user to open a `.fbx` file, uploads the individual components
|
||||
of the model as meshes, and generates a character rig for use in
|
||||
animation, which is loaded into the `Class.Workspace`.
|
||||
description: |
|
||||
Prompts the user to open a `.fbx` file, uploads the individual components
|
||||
of the model as meshes, and generates a character rig for use in
|
||||
animation, which is loaded into the `Class.Workspace`.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: isR15
|
||||
type: boolean
|
||||
default: true
|
||||
summary: ''
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:Intersect
|
||||
summary: |
|
||||
Intersects the given parts and returns the resulting
|
||||
|
|
@ -668,29 +668,6 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:PromptForExistingAssetIdAsync
|
||||
summary: |
|
||||
Opens a window in Roblox Studio which prompts the user to select an asset
|
||||
based on the `assetType` specified.
|
||||
description: |
|
||||
Opens a window in Roblox Studio which prompts the user to select an asset
|
||||
based on the `assetType` specified. Returns what asset ID was selected, or
|
||||
`-1` if the window was closed.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: assetType
|
||||
type: string
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: int64
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:PromptForExistingAssetId
|
||||
summary: |
|
||||
Opens a window in Roblox Studio which prompts the user to select an asset
|
||||
|
|
@ -711,21 +688,22 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:PromptSaveSelectionAsync
|
||||
- name: Plugin:PromptForExistingAssetIdAsync
|
||||
summary: |
|
||||
Prompts the user to save their current selection with the specified file
|
||||
name.
|
||||
Opens a window in Roblox Studio which prompts the user to select an asset
|
||||
based on the `assetType` specified.
|
||||
description: |
|
||||
Prompts the user to save their current selection with the specified file
|
||||
name. Returns `true` if the user did save the file.
|
||||
Opens a window in Roblox Studio which prompts the user to select an asset
|
||||
based on the `assetType` specified. Returns what asset ID was selected, or
|
||||
`-1` if the window was closed.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: suggestedFileName
|
||||
- name: assetType
|
||||
type: string
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: boolean
|
||||
- type: int64
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
|
|
@ -756,6 +734,28 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:PromptSaveSelectionAsync
|
||||
summary: |
|
||||
Prompts the user to save their current selection with the specified file
|
||||
name.
|
||||
description: |
|
||||
Prompts the user to save their current selection with the specified file
|
||||
name. Returns `true` if the user did save the file.
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: suggestedFileName
|
||||
type: string
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: boolean
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: Plugin:SaveSelectedToRoblox
|
||||
summary: |
|
||||
Opens an upload window for the user's current selection.
|
||||
|
|
|
|||
|
|
@ -94,12 +94,6 @@ methods:
|
|||
<td>When <code>true</code>, the player can <b>not</b> interact with paid random item generators, either via in‑experience currency bought with Robux or Robux directly.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>AllowedExternalLinkReferences</code></td>
|
||||
<td>Array</td>
|
||||
<td>Any experience that references external links.</td>
|
||||
<td>A list of external link references such as social media links, handles, or iconography that a player is permitted to see. Possible values include <code>"Discord"</code>, <code>"Facebook"</code>, <code>"Twitch"</code>, <code>"YouTube"</code>, <code>"X"</code>, <code>"GitHub"</code>, and <code>"Guilded"</code>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>IsContentSharingAllowed</code></td>
|
||||
<td>Boolean</td>
|
||||
<td>Any feature in the experience that enables users to create content (e.g. text, images, video, audio) that other users can see in the experience or allows user to share content within experiences.</td>
|
||||
|
|
@ -135,6 +129,12 @@ methods:
|
|||
<td>Any experience that is available in China.</td>
|
||||
<td>When <code>true</code>, an experience should enforce compliance changes. See <a href="https://devforum.roblox.com/t/new-programs-available-roblox-china-licensed-to-operate/1023361">this forum post</a> for more information.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>AllowedExternalLinkReferences</code></td>
|
||||
<td>Array</td>
|
||||
<td>Not required.</td>
|
||||
<td>This is a legacy field. It always returns an empty array.</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
|
|
|||
|
|
@ -170,62 +170,56 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: ReflectionService:GetPropertiesOfClass
|
||||
- name: ReflectionService:GetEventsOfClass
|
||||
summary: |
|
||||
Returns a list of properties for a given class with filters applied.
|
||||
Returns a list of events for a given class with filters applied.
|
||||
description: |
|
||||
Given a class name in the Roblox API, returns a list of
|
||||
`ReflectedProperty` dictionaries for all properties of that class that
|
||||
match the provided filter criteria. If no such class name exists, returns
|
||||
`nil`.
|
||||
Given a class name in the Roblox API, returns a list of `ReflectedEvent`
|
||||
dictionaries for all events of that class that match the provided filter
|
||||
criteria. If no such class name exists, returns `nil`.
|
||||
|
||||
If you pass in a `ReflectionMemberFilter` dictionary, you can adjust the
|
||||
set of eligible properties and adjust the output behavior:
|
||||
set of eligible events and adjust the output behavior:
|
||||
|
||||
```lua
|
||||
{
|
||||
-- The security context to use; can be more expansive than the current script's security
|
||||
Security: SecurityCapabilities?, -- default: SecurityCapabilities.fromCurrent()
|
||||
-- Whether to exclude inherited properties from superclasses
|
||||
-- Whether to exclude inherited events from superclasses
|
||||
ExcludeInherited: boolean?, -- default: false
|
||||
-- Whether to exclude Studio display information about the properties
|
||||
-- Whether to exclude Studio display information about the events
|
||||
ExcludeDisplay: boolean?, -- default: false
|
||||
}
|
||||
```
|
||||
|
||||
If the class name is valid and that class has properties, you'll get a
|
||||
list of `ReflectedProperty` dictionaries as output, each with the
|
||||
following structure:
|
||||
If the class name is valid and that class has events, you'll get a list of
|
||||
`ReflectedEvent` dictionaries as output, each with the following
|
||||
structure:
|
||||
|
||||
```lua
|
||||
{
|
||||
-- The name of the property
|
||||
-- The name of the event
|
||||
Name: string,
|
||||
-- The superclass from which the property is inherited, or the class name if not inherited
|
||||
Owner: string,
|
||||
-- Whether the property is serialized (able to be saved to disk or sent over the network)
|
||||
Serialized: boolean,
|
||||
-- The type of the property
|
||||
Type: ReflectionType,
|
||||
-- The content type of the property, if applicable
|
||||
ContentType: Enum.AssetType?,
|
||||
-- A list of all parameters the event passes to connected functions
|
||||
Parameters: {
|
||||
{
|
||||
-- The name of the parameter
|
||||
Name: string,
|
||||
-- The type of the parameter
|
||||
Type: ReflectionType,
|
||||
}
|
||||
},
|
||||
-- Studio display information
|
||||
Display: {
|
||||
-- The category under which the property is listed in Studio
|
||||
Category: string,
|
||||
-- A message indicating that the property is deprecated, if applicable
|
||||
-- A message indicating that the event is deprecated, if applicable
|
||||
DeprecationMessage: string?,
|
||||
}?,
|
||||
-- The security permissions required to access this property
|
||||
-- The security permissions required to access this event
|
||||
Permits: {
|
||||
-- The security context required to read this property
|
||||
Read: SecurityCapabilities?,
|
||||
-- The security context required to read this property while thread-safe
|
||||
ReadParallel: SecurityCapabilities?,
|
||||
-- The security context required to write to this property
|
||||
Write: SecurityCapabilities?,
|
||||
-- The security context required to write to this property while thread-safe
|
||||
WriteParallel: SecurityCapabilities?,
|
||||
-- The security permissions required to listen for the event in any context
|
||||
Listen: SecurityCapabilities?,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
|
@ -235,18 +229,18 @@ methods:
|
|||
type: string
|
||||
default:
|
||||
summary: |
|
||||
The name of the class for which you wish to retrieve properties.
|
||||
The name of the class for which you wish to retrieve events.
|
||||
- name: filter
|
||||
type: Dictionary
|
||||
default: nil
|
||||
summary: |
|
||||
An optional filter to restrict or expand the set of properties that
|
||||
this method can return and change the method's behavior.
|
||||
An optional filter to restrict or expand the set of events that this
|
||||
method can return and change the method's behavior.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A list of `ReflectedProperty` dictionaries with reflection information
|
||||
for each property of the class that matches the filter criteria.
|
||||
A list of `ReflectedEvent` dictionaries with reflection information
|
||||
for each event of the class that matches the filter criteria.
|
||||
tags:
|
||||
- CustomLuaState
|
||||
deprecation_message: ''
|
||||
|
|
@ -338,56 +332,62 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: ReflectionService:GetEventsOfClass
|
||||
- name: ReflectionService:GetPropertiesOfClass
|
||||
summary: |
|
||||
Returns a list of events for a given class with filters applied.
|
||||
Returns a list of properties for a given class with filters applied.
|
||||
description: |
|
||||
Given a class name in the Roblox API, returns a list of `ReflectedEvent`
|
||||
dictionaries for all events of that class that match the provided filter
|
||||
criteria. If no such class name exists, returns `nil`.
|
||||
Given a class name in the Roblox API, returns a list of
|
||||
`ReflectedProperty` dictionaries for all properties of that class that
|
||||
match the provided filter criteria. If no such class name exists, returns
|
||||
`nil`.
|
||||
|
||||
If you pass in a `ReflectionMemberFilter` dictionary, you can adjust the
|
||||
set of eligible events and adjust the output behavior:
|
||||
set of eligible properties and adjust the output behavior:
|
||||
|
||||
```lua
|
||||
{
|
||||
-- The security context to use; can be more expansive than the current script's security
|
||||
Security: SecurityCapabilities?, -- default: SecurityCapabilities.fromCurrent()
|
||||
-- Whether to exclude inherited events from superclasses
|
||||
-- Whether to exclude inherited properties from superclasses
|
||||
ExcludeInherited: boolean?, -- default: false
|
||||
-- Whether to exclude Studio display information about the events
|
||||
-- Whether to exclude Studio display information about the properties
|
||||
ExcludeDisplay: boolean?, -- default: false
|
||||
}
|
||||
```
|
||||
|
||||
If the class name is valid and that class has events, you'll get a list of
|
||||
`ReflectedEvent` dictionaries as output, each with the following
|
||||
structure:
|
||||
If the class name is valid and that class has properties, you'll get a
|
||||
list of `ReflectedProperty` dictionaries as output, each with the
|
||||
following structure:
|
||||
|
||||
```lua
|
||||
{
|
||||
-- The name of the event
|
||||
-- The name of the property
|
||||
Name: string,
|
||||
-- The superclass from which the property is inherited, or the class name if not inherited
|
||||
Owner: string,
|
||||
-- A list of all parameters the event passes to connected functions
|
||||
Parameters: {
|
||||
{
|
||||
-- The name of the parameter
|
||||
Name: string,
|
||||
-- The type of the parameter
|
||||
Type: ReflectionType,
|
||||
}
|
||||
},
|
||||
-- Whether the property is serialized (able to be saved to disk or sent over the network)
|
||||
Serialized: boolean,
|
||||
-- The type of the property
|
||||
Type: ReflectionType,
|
||||
-- The content type of the property, if applicable
|
||||
ContentType: Enum.AssetType?,
|
||||
-- Studio display information
|
||||
Display: {
|
||||
-- A message indicating that the event is deprecated, if applicable
|
||||
-- The category under which the property is listed in Studio
|
||||
Category: string,
|
||||
-- A message indicating that the property is deprecated, if applicable
|
||||
DeprecationMessage: string?,
|
||||
}?,
|
||||
-- The security permissions required to access this event
|
||||
-- The security permissions required to access this property
|
||||
Permits: {
|
||||
-- The security permissions required to listen for the event in any context
|
||||
Listen: SecurityCapabilities?,
|
||||
-- The security context required to read this property
|
||||
Read: SecurityCapabilities?,
|
||||
-- The security context required to read this property while thread-safe
|
||||
ReadParallel: SecurityCapabilities?,
|
||||
-- The security context required to write to this property
|
||||
Write: SecurityCapabilities?,
|
||||
-- The security context required to write to this property while thread-safe
|
||||
WriteParallel: SecurityCapabilities?,
|
||||
},
|
||||
}
|
||||
```
|
||||
|
|
@ -397,18 +397,18 @@ methods:
|
|||
type: string
|
||||
default:
|
||||
summary: |
|
||||
The name of the class for which you wish to retrieve events.
|
||||
The name of the class for which you wish to retrieve properties.
|
||||
- name: filter
|
||||
type: Dictionary
|
||||
default: nil
|
||||
summary: |
|
||||
An optional filter to restrict or expand the set of events that this
|
||||
method can return and change the method's behavior.
|
||||
An optional filter to restrict or expand the set of properties that
|
||||
this method can return and change the method's behavior.
|
||||
returns:
|
||||
- type: Array
|
||||
summary: |
|
||||
A list of `ReflectedEvent` dictionaries with reflection information
|
||||
for each event of the class that matches the filter criteria.
|
||||
A list of `ReflectedProperty` dictionaries with reflection information
|
||||
for each property of the class that matches the filter criteria.
|
||||
tags:
|
||||
- CustomLuaState
|
||||
deprecation_message: ''
|
||||
|
|
|
|||
|
|
@ -0,0 +1,81 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: RemoteCommandService
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags:
|
||||
- NotCreatable
|
||||
- Service
|
||||
deprecation_message: ''
|
||||
properties: []
|
||||
methods:
|
||||
- name: RemoteCommandService:GetExecutingPlayer
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Player
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Unknown
|
||||
- name: RemoteCommandService:GetReceivedUpdateSignal
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: RBXScriptSignal
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Unknown
|
||||
- name: RemoteCommandService:GetStoppingSignal
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: RBXScriptSignal
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Unknown
|
||||
- name: RemoteCommandService:SendUpdate
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: args
|
||||
type: Tuple
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Unknown
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -486,6 +486,34 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- UI
|
||||
methods: []
|
||||
methods:
|
||||
- name: ScrollingFrame:GetScrollVelocity
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Vector2
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- name: ScrollingFrame:ResetScrollVelocity
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: Seat.Occupant
|
||||
summary: |
|
||||
The humanoid that is sitting in the seat.
|
||||
|
|
@ -102,7 +102,7 @@ properties:
|
|||
can_save: false
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
methods:
|
||||
- name: Seat:Sit
|
||||
summary: |
|
||||
|
|
@ -126,6 +126,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -0,0 +1,37 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: SelfViewConfiguration
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- BaseCoreGuiConfiguration
|
||||
descendants: []
|
||||
tags:
|
||||
- NotCreatable
|
||||
- NotReplicated
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: SelfViewConfiguration.Open
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: State
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -65,7 +65,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: ShirtGraphic.Graphic
|
||||
summary: |
|
||||
The content ID link pointing to the `Class.ShirtGraphic` texture hosted on
|
||||
|
|
@ -93,7 +93,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -46,7 +46,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -426,6 +426,49 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Social
|
||||
- name: SocialService:PromptLinkSharing
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: player
|
||||
type: Player
|
||||
default:
|
||||
summary: |
|
||||
Prompts the given `Class.Player` with a Roblox platform-level share
|
||||
sheet with a generated share link.
|
||||
- name: options
|
||||
type: Dictionary
|
||||
default: nil
|
||||
summary: |
|
||||
`Dictionary` that specifies the configuration for the generated link.
|
||||
It includes the following optional key-value pairs:
|
||||
|
||||
- `FallbackLinkId` (string). Determines how this share link will
|
||||
direct player to once expired. Default to experience join link.
|
||||
- `ExpirationSeconds` (number). Determines time to expiration once the
|
||||
share link is created. Truncates to nearest integer. Defaults to
|
||||
86,400.
|
||||
- `PreviewTitle` (string) Preview title of the share link.
|
||||
- `PreviewDescription` (string) Preview description of the share link.
|
||||
- `PreviewAssetId` (number) Image asset ID used for share link
|
||||
preview.
|
||||
- `LaunchData` (string). Used to set a parameter in
|
||||
`Class.Player:GetJoinData()` when a player joined using the
|
||||
generated share link.
|
||||
returns:
|
||||
- type: Tuple
|
||||
summary: |
|
||||
A tuple containing an `Enum.PromptLinkSharingResult` indicating the
|
||||
result of the link sharing prompt.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Social
|
||||
- name: SocialService:PromptLinkSharingAsync
|
||||
summary: ''
|
||||
description: |
|
||||
|
|
@ -498,49 +541,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Social
|
||||
- name: SocialService:PromptLinkSharing
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: player
|
||||
type: Player
|
||||
default:
|
||||
summary: |
|
||||
Prompts the given `Class.Player` with a Roblox platform-level share
|
||||
sheet with a generated share link.
|
||||
- name: options
|
||||
type: Dictionary
|
||||
default: nil
|
||||
summary: |
|
||||
`Dictionary` that specifies the configuration for the generated link.
|
||||
It includes the following optional key-value pairs:
|
||||
|
||||
- `FallbackLinkId` (string). Determines how this share link will
|
||||
direct player to once expired. Default to experience join link.
|
||||
- `ExpirationSeconds` (number). Determines time to expiration once the
|
||||
share link is created. Truncates to nearest integer. Defaults to
|
||||
86,400.
|
||||
- `PreviewTitle` (string) Preview title of the share link.
|
||||
- `PreviewDescription` (string) Preview description of the share link.
|
||||
- `PreviewAssetId` (number) Image asset ID used for share link
|
||||
preview.
|
||||
- `LaunchData` (string). Used to set a parameter in
|
||||
`Class.Player:GetJoinData()` when a player joined using the
|
||||
generated share link.
|
||||
returns:
|
||||
- type: Tuple
|
||||
summary: |
|
||||
A tuple containing an `Enum.PromptLinkSharingResult` indicating the
|
||||
result of the link sharing prompt.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Social
|
||||
- name: SocialService:PromptPhoneBook
|
||||
summary: |
|
||||
Prompts the given `Class.Player` with the phone book.
|
||||
|
|
|
|||
|
|
@ -32,6 +32,23 @@ descendants: []
|
|||
tags: []
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: Sound.AcousticSimulationEnabled
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Emitter
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- LegacySound
|
||||
- name: Sound.AudioContent
|
||||
summary: |
|
||||
A reference to an audio asset.
|
||||
|
|
|
|||
|
|
@ -600,6 +600,22 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.CameraNavigationModel
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: CameraNavigationModel
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Camera
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.CameraOrbitSensitivity
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -716,6 +732,38 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.CommandBarEnterExec
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Script Editor
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.CommandBarFont
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: QFont
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Script Editor
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.CommandBarLocalState
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -886,6 +934,22 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerLengthFactor
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerMajorGridIncrement
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -934,6 +998,38 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerScaleFactor
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowAxisTicks
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowHoverRuler
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -966,6 +1062,38 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowNegativeAxes
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowPlanes
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowTargetSnap
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -982,6 +1110,38 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowTrackball
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerShowWhileDragging
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.DraggerSoftSnapMarginFactor
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -1343,6 +1503,22 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities: []
|
||||
- name: Studio.ExternalEditorSelection
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: QDir
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Directories
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.Find Selection Background Color
|
||||
summary: |
|
||||
Sets the highlight color of matches in the script editor's Find Selection
|
||||
|
|
@ -2888,6 +3064,22 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.UseDefaultExternalEditor
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: RobloxScriptSecurity
|
||||
write: RobloxScriptSecurity
|
||||
thread_safety: ReadSafe
|
||||
category: Directories
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities: []
|
||||
- name: Studio.Warning Color
|
||||
summary: |
|
||||
Specifies the color of the wavy underline shown when the script analyzer
|
||||
|
|
|
|||
|
|
@ -341,6 +341,34 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: StudioService:PromptImportFile
|
||||
summary: |
|
||||
Prompts the current Studio user to select one file to add as a
|
||||
`Class.File`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: fileTypeFilter
|
||||
type: Array
|
||||
default: '{}'
|
||||
summary: |
|
||||
A list of file types that the user is allowed to select. File types
|
||||
are formatted without a period. For example, {"jpg", "png"} would
|
||||
allow only a JPG or PNG file to be selected. If no filter is provided,
|
||||
the filter is `nil` and allows the user to select any file type.
|
||||
returns:
|
||||
- type: Instance
|
||||
summary: |
|
||||
The imported `Class.File`. Returns `nil` if no files were selected, or
|
||||
if the selected file was too large (FileSize greater than 100
|
||||
megabytes).
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: StudioService:PromptImportFileAsync
|
||||
summary: |
|
||||
Prompts the current Studio user to select one file to add as a
|
||||
|
|
@ -375,10 +403,10 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: StudioService:PromptImportFile
|
||||
- name: StudioService:PromptImportFiles
|
||||
summary: |
|
||||
Prompts the current Studio user to select one file to add as a
|
||||
`Class.File`.
|
||||
Prompts the current Studio user to select files to add as
|
||||
`Class.File|Files`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
|
|
@ -388,14 +416,14 @@ methods:
|
|||
summary: |
|
||||
A list of file types that the user is allowed to select. File types
|
||||
are formatted without a period. For example, {"jpg", "png"} would
|
||||
allow only a JPG or PNG file to be selected. If no filter is provided,
|
||||
allow only JPG and PNG files to be selected. If no filter is provided,
|
||||
the filter is `nil` and allows the user to select any file type.
|
||||
returns:
|
||||
- type: Instance
|
||||
- type: Instances
|
||||
summary: |
|
||||
The imported `Class.File`. Returns `nil` if no files were selected, or
|
||||
if the selected file was too large (FileSize greater than 100
|
||||
megabytes).
|
||||
The imported `Class.File|Files`. Returns an empty list if no files
|
||||
were selected. Returns `nil` if the user selected one or more files
|
||||
that were too large (FileSize greater than 100 megabytes).
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
|
|
@ -439,33 +467,5 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: StudioService:PromptImportFiles
|
||||
summary: |
|
||||
Prompts the current Studio user to select files to add as
|
||||
`Class.File|Files`.
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: fileTypeFilter
|
||||
type: Array
|
||||
default: '{}'
|
||||
summary: |
|
||||
A list of file types that the user is allowed to select. File types
|
||||
are formatted without a period. For example, {"jpg", "png"} would
|
||||
allow only JPG and PNG files to be selected. If no filter is provided,
|
||||
the filter is `nil` and allows the user to select any file type.
|
||||
returns:
|
||||
- type: Instances
|
||||
summary: |
|
||||
The imported `Class.File|Files`. Returns an empty list if no files
|
||||
were selected. Returns `nil` if the user selected one or more files
|
||||
that were too large (FileSize greater than 100 megabytes).
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -240,6 +240,20 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- name: StyleRule:GetPropertyTransitions
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: Dictionary
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- name: StyleRule:SetProperties
|
||||
summary: |
|
||||
Lets you declare and set multiple properties of the `StyleRule` at once.
|
||||
|
|
@ -384,5 +398,23 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
- name: StyleRule:SetPropertyTransitions
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: properties
|
||||
type: Dictionary
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- UI
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -342,6 +342,35 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Teleport
|
||||
- name: TeleportService:ReserveServer
|
||||
summary: |
|
||||
Returns an access code that can be used to teleport players to a reserved
|
||||
server, along with the `Class.DataModel.PrivateServerId` for it.
|
||||
description: ''
|
||||
code_samples:
|
||||
- TeleportService-ReserveServer1
|
||||
- teleportservice-teleport-to-a-reserved-server-via-chat
|
||||
parameters:
|
||||
- name: placeId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Class.DataModel.PlaceId` of the place the reserved server is
|
||||
being created for.
|
||||
returns:
|
||||
- type: Tuple
|
||||
summary: |
|
||||
The server access code required by
|
||||
`Class.TeleportService:TeleportToPrivateServer()` and the
|
||||
`Class.DataModel.PrivateServerId` for the reserved server.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Teleport
|
||||
- name: TeleportService:ReserveServerAsync
|
||||
summary: |
|
||||
Returns an access code that can be used to teleport players to a reserved
|
||||
|
|
@ -411,35 +440,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Teleport
|
||||
- name: TeleportService:ReserveServer
|
||||
summary: |
|
||||
Returns an access code that can be used to teleport players to a reserved
|
||||
server, along with the `Class.DataModel.PrivateServerId` for it.
|
||||
description: ''
|
||||
code_samples:
|
||||
- TeleportService-ReserveServer1
|
||||
- teleportservice-teleport-to-a-reserved-server-via-chat
|
||||
parameters:
|
||||
- name: placeId
|
||||
type: int64
|
||||
default:
|
||||
summary: |
|
||||
The `Class.DataModel.PlaceId` of the place the reserved server is
|
||||
being created for.
|
||||
returns:
|
||||
- type: Tuple
|
||||
summary: |
|
||||
The server access code required by
|
||||
`Class.TeleportService:TeleportToPrivateServer()` and the
|
||||
`Class.DataModel.PrivateServerId` for the reserved server.
|
||||
tags:
|
||||
- Yields
|
||||
- Deprecated
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Teleport
|
||||
- name: TeleportService:SetTeleportGui
|
||||
summary: |
|
||||
Sets the custom `Class.ScreenGui|teleport GUI` that will be shown to the
|
||||
|
|
|
|||
|
|
@ -692,22 +692,6 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: TestService:RunAsync
|
||||
summary: |
|
||||
Runs scripts which are parented to `TestService`.
|
||||
description: |
|
||||
Runs scripts which are parented to `TestService`.
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: TestService:Run
|
||||
summary: |
|
||||
Runs scripts which are parented to `TestService`.
|
||||
|
|
@ -724,6 +708,22 @@ methods:
|
|||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: TestService:RunAsync
|
||||
summary: |
|
||||
Runs scripts which are parented to `TestService`.
|
||||
description: |
|
||||
Runs scripts which are parented to `TestService`.
|
||||
code_samples: []
|
||||
parameters: []
|
||||
returns:
|
||||
- type: ()
|
||||
summary: ''
|
||||
tags:
|
||||
- Yields
|
||||
deprecation_message: ''
|
||||
security: PluginSecurity
|
||||
thread_safety: Unsafe
|
||||
capabilities: []
|
||||
- name: TestService:ScopeTime
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
|
|||
|
|
@ -87,30 +87,34 @@ properties:
|
|||
`Class.TextChatService.OnIncomingMessage` and
|
||||
`Class.TextChannel.OnIncomingMessage` callbacks.
|
||||
|
||||
```
|
||||
```lua
|
||||
local Players = game:GetService("Players")
|
||||
local TextChatService = game:GetService("TextChatService")
|
||||
|
||||
local generalChannel: TextChannel = TextChatService:WaitForChild("TextChannels").RBXGeneral
|
||||
local customChannel: TextChannel = Instance.new("TextChannel")
|
||||
customChannel.Parent = TextChatService:WaitForChild("TextChannels")
|
||||
|
||||
generalChannel:DisplaySystemMessage("This is an error!", "Game.Error.Generic")
|
||||
generalChannel:DisplaySystemMessage("Could not find save data!", "Game.Error.SaveDataNotFound")
|
||||
customChannel.OnIncomingMessage = function(message: TextChatMessage)
|
||||
if string.find(message.Metadata, "Error") then
|
||||
local overrideProperties = Instance.new("TextChatMessageProperties")
|
||||
overrideProperties.Text = string.format("<font color='rgb(255,0,0)'>%s</font>", message.Text)
|
||||
return overrideProperties
|
||||
elseif string.find(message.Metadata, "Info") then
|
||||
local overrideProperties = Instance.new("TextChatMessageProperties")
|
||||
overrideProperties.Text = string.format("<font color='rgb(0, 255, 150)'>%s</font>", message.Text)
|
||||
return overrideProperties
|
||||
end
|
||||
|
||||
generalChannel:DisplaySystemMessage("You won the game!", "Game.Info.Win")
|
||||
generalChannel:DisplaySystemMessage("You lost the game!", "Game.Info.Lose")
|
||||
|
||||
generalChannel.OnIncomingMessage = function(message: TextChatMessage)
|
||||
if string.find(message.Metadata, "Error") then
|
||||
local overrideProperties = Instance.new("TextChatMessageProperties")
|
||||
overrideProperties.TextColor = Color3.fromRGB(255, 0, 0)
|
||||
return overrideProperties
|
||||
elseif string.find(message.Metadata, "Info") then
|
||||
local overrideProperties = Instance.new("TextChatMessageProperties")
|
||||
overrideProperties.TextColor = Color3.fromRGB(0, 255, 150)
|
||||
return overrideProperties
|
||||
end
|
||||
|
||||
return nil
|
||||
return nil
|
||||
end
|
||||
|
||||
Players.LocalPlayer.CharacterAdded:Connect(function()
|
||||
customChannel:DisplaySystemMessage("This is an error!", "Game.Error.Generic")
|
||||
customChannel:DisplaySystemMessage("Could not find save data!", "Game.Error.SaveDataNotFound")
|
||||
|
||||
customChannel:DisplaySystemMessage("You won the game!", "Game.Info.Win")
|
||||
customChannel:DisplaySystemMessage("You lost the game!", "Game.Info.Lose")
|
||||
end)
|
||||
```
|
||||
|
||||
As follows is a reference of the default system messages emitted by the
|
||||
|
|
|
|||
|
|
@ -290,7 +290,7 @@ methods:
|
|||
description: |
|
||||
Determines whether or not two users would receive messages between each
|
||||
other. Factors such as incompatible parental control settings or blocked
|
||||
status may prevent the delivery of messages between users
|
||||
status may prevent the delivery of messages between users.
|
||||
`Class.TextChannel|TextChannels` internally use this result to determine
|
||||
whether to deliver messages between users. Note that this method is only
|
||||
available for use in a `Class.Script` with
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ properties:
|
|||
The largest size in pixels the font is allowed to be.
|
||||
description: |
|
||||
This property indicates the largest size in pixels the font is allowed to
|
||||
be. It defaults to 1000 pixels and much be set larger than or equal to the
|
||||
be. It defaults to 1000 pixels and must be set larger than or equal to the
|
||||
`Class.UITextSizeConstraint.MinTextSize|MinTextSize` property.
|
||||
|
||||
If the affected `Class.GuiObject` has its
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: UniqueIdLookupService
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags:
|
||||
- NotCreatable
|
||||
- Service
|
||||
deprecation_message: ''
|
||||
properties: []
|
||||
methods:
|
||||
- name: UniqueIdLookupService:GetOrCreateUniqueIdRemoteCommand
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
parameters:
|
||||
- name: instance
|
||||
type: Instance
|
||||
default:
|
||||
summary: ''
|
||||
returns:
|
||||
- type: string
|
||||
summary: ''
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Unknown
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
@ -48,7 +48,7 @@ properties:
|
|||
can_save: false
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.Disabled
|
||||
summary: |
|
||||
Toggles whether the `Class.VehicleSeat` is active or not.
|
||||
|
|
@ -70,7 +70,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.HeadsUpDisplay
|
||||
summary: |
|
||||
If true, a fancy speed bar will be displayed speed on screen that tells
|
||||
|
|
@ -92,7 +92,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.MaxSpeed
|
||||
summary: |
|
||||
The maximum speed that can be attained.
|
||||
|
|
@ -112,7 +112,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.Occupant
|
||||
summary: |
|
||||
The humanoid that is sitting in the seat.
|
||||
|
|
@ -134,7 +134,7 @@ properties:
|
|||
can_save: false
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.Steer
|
||||
summary: |
|
||||
The direction of movement, tied to the keys A and D. Must be one of 1
|
||||
|
|
@ -162,7 +162,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.SteerFloat
|
||||
summary: |
|
||||
Functions identically to `Class.VehicleSeat.Steer`, but the value is not
|
||||
|
|
@ -184,7 +184,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.Throttle
|
||||
summary: |
|
||||
The direction of movement, tied to the keys W and S. Must be an integer 1
|
||||
|
|
@ -212,7 +212,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.ThrottleFloat
|
||||
summary: |
|
||||
Functions identically to `Class.VehicleSeat.Throttle`, but the value is
|
||||
|
|
@ -234,7 +234,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.Torque
|
||||
summary: |
|
||||
How fast the vehicles will be able to attain `Class.VehicleSeat.MaxSpeed`.
|
||||
|
|
@ -256,7 +256,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
- name: VehicleSeat.TurnSpeed
|
||||
summary: |
|
||||
The speed at which the vehicle will turn. Higher numbers can cause
|
||||
|
|
@ -278,7 +278,7 @@ properties:
|
|||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
methods:
|
||||
- name: VehicleSeat:Sit
|
||||
summary: |
|
||||
|
|
@ -303,6 +303,6 @@ methods:
|
|||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Basic
|
||||
- Avatar
|
||||
- AvatarBehavior
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -47,7 +47,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapDeformer:GetDeformedCFrameAsync
|
||||
summary: |
|
||||
Returns a `Datatype.CFrame` deformed comparably to the `Class.MeshPart`.
|
||||
|
|
@ -75,7 +75,7 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapDeformer:SetCageMeshContent
|
||||
summary: |
|
||||
Sets the cage mesh used to deform against a sibling `Class.WrapTarget`
|
||||
|
|
@ -103,6 +103,6 @@ methods:
|
|||
security: None
|
||||
thread_safety: Unsafe
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.BindOffset
|
||||
summary: |
|
||||
`Datatype.CFrame` is used to adjust a binding point for clothing item
|
||||
|
|
@ -68,7 +68,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.Color
|
||||
summary: |
|
||||
Sets color used for the debug rendering. See `Class.WrapTarget.DebugMode`.
|
||||
|
|
@ -89,7 +89,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.DebugMode
|
||||
summary: |
|
||||
Allows switching between different debugging visualization modes for cage
|
||||
|
|
@ -112,7 +112,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.Enabled
|
||||
summary: |
|
||||
Allows for disabling of the `Class.WrapLayer` object as if it does not
|
||||
|
|
@ -133,7 +133,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.Order
|
||||
summary: |
|
||||
Controls the composition order for layered clothing.
|
||||
|
|
@ -155,7 +155,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.Puffiness
|
||||
summary: |
|
||||
Controls how much underlying clothing items inflate the current clothing
|
||||
|
|
@ -183,7 +183,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.ReferenceMeshContent
|
||||
summary: ''
|
||||
description: ''
|
||||
|
|
@ -200,7 +200,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.ReferenceMeshId
|
||||
summary: |
|
||||
AssetID for reference mesh used to define Inner Cage of a 3D object.
|
||||
|
|
@ -226,7 +226,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.ReferenceOrigin
|
||||
summary: |
|
||||
Reference mesh offset relative to parent MeshPart (in the parent MeshPart
|
||||
|
|
@ -251,7 +251,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.ReferenceOriginWorld
|
||||
summary: |
|
||||
Reference mesh offset relative to parent MeshPart (in the world space)
|
||||
|
|
@ -276,7 +276,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapLayer.ShrinkFactor
|
||||
summary: |
|
||||
Allows slight shrinking/expanding of the resulting render mesh, without
|
||||
|
|
@ -307,7 +307,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapTarget.DebugMode
|
||||
summary: |
|
||||
Allows switching between different debugging visualization modes for cage
|
||||
|
|
@ -65,7 +65,7 @@ properties:
|
|||
can_load: false
|
||||
can_save: false
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapTarget.Stiffness
|
||||
summary: |
|
||||
Defines how much the body mesh can be compressed by clothing.
|
||||
|
|
@ -95,7 +95,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
|
|
@ -68,7 +68,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapTextureTransfer.UVMaxBound
|
||||
summary: |
|
||||
Determines the maximum bound of the UV space to include in the transfer.
|
||||
|
|
@ -95,7 +95,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
- name: WrapTextureTransfer.UVMinBound
|
||||
summary: |
|
||||
Determines the minimum bound of the UV space to include in the transfer.
|
||||
|
|
@ -121,7 +121,7 @@ properties:
|
|||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Avatar
|
||||
- AvatarAppearance
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue