mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-24 06:34:09 +00:00
update rules
This commit is contained in:
Joe
parent
4c390fdd37
commit
d5522b2fef
8549 changed files with 11783 additions and 1888 deletions
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AccessModifierType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Allow
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Deny
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,140 @@
|
|||
# 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: AccessoryType
|
||||
type: enum
|
||||
summary: |
|
||||
A subset of AssetTypes which are relevant to only accessories.
|
||||
description: |
|
||||
AccessoryType is a subset of AssetTypes which are relevant to only
|
||||
accessories.
|
||||
|
||||
To get the AccessoryType of an accessory, see the Type on the accessory's web
|
||||
page. For example, see
|
||||
[Yi the Art Teacher - Hair](https://www.roblox.com/catalog/5911063681/Yi-the-Art-Teacher-Hair).
|
||||
|
||||
AccessoryTypes are mainly used in the AccessoryBlob of HumanoidDescription,
|
||||
and to specify the type in Accessory.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Unknown
|
||||
summary: |
|
||||
If the accessory type is not known.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Hat
|
||||
summary: |
|
||||
A hat accessory (may be a rigid or layered accessory).
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Hair
|
||||
summary: |
|
||||
A hair accessory (may be a rigid or layered accessory).
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Face
|
||||
summary: |
|
||||
A face accessory (may be a rigid or layered accessory).
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Neck
|
||||
summary: |
|
||||
A neck Accessory (may be a rigid or layered accessory).
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shoulder
|
||||
summary: |
|
||||
A shoulder accessory (may be a rigid or layered accessory).
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Front
|
||||
summary: |
|
||||
A front accessory (may be a rigid or layered accessory).
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Back
|
||||
summary: |
|
||||
A back accessory (may be a rigid or layered accessory).
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Waist
|
||||
summary: |
|
||||
A waist accessory (may be a rigid or layered accessory).
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TShirt
|
||||
summary: |
|
||||
A layered clothing T-Shirt accessory.
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shirt
|
||||
summary: |
|
||||
A layered clothing shirt accessory.
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Pants
|
||||
summary: |
|
||||
A layered clothing pants accessory.
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Jacket
|
||||
summary: |
|
||||
A layered clothing jacket accessory.
|
||||
value: 12
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Sweater
|
||||
summary: |
|
||||
A layered clothing sweater accessory.
|
||||
value: 13
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shorts
|
||||
summary: |
|
||||
A layered clothing shorts accessory.
|
||||
value: 14
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftShoe
|
||||
summary: |
|
||||
A layered clothing left shoe accessory.
|
||||
value: 15
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightShoe
|
||||
summary: |
|
||||
A layered clothing right shoe accessory.
|
||||
value: 16
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DressSkirt
|
||||
summary: |
|
||||
A layered clothing dress or skirt accessory.
|
||||
value: 17
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Eyebrow
|
||||
summary: ''
|
||||
value: 18
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Eyelash
|
||||
summary: ''
|
||||
value: 19
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: ActionOnAutoResumeSync
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: DontResume
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: KeepStudio
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: KeepLocal
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: ActionOnStopSync
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: AlwaysAsk
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: KeepLocalFiles
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DeleteLocalFiles
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: ActionType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Nothing
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Pause
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Lose
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Draw
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Win
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: ActuatorRelativeTo
|
||||
type: enum
|
||||
summary: |
|
||||
The CFrame value in which the body mover constraint is expressed.
|
||||
description: |
|
||||
The CFrame value in which the body mover constraint is expressed.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Attachment0
|
||||
summary: |
|
||||
The constraint is expressed relative to Attachment0.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Attachment1
|
||||
summary: |
|
||||
The constraint is expressed relative to Attachment1.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: World
|
||||
summary: |
|
||||
The constraint is expressed relative to the game world.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# 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: ActuatorType
|
||||
type: enum
|
||||
summary: |
|
||||
The active physics component of the constraint.
|
||||
description: |
|
||||
The active physics component of the constraint.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: |
|
||||
The motor and servo components are both disabled.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Motor
|
||||
summary: |
|
||||
The motor component is enabled. Motor properties are active and the
|
||||
actuator will apply continuous force.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Servo
|
||||
summary: |
|
||||
The servo component is enabled. Servo properties are active and the
|
||||
actuator will apply force to approach the servo's target.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,58 @@
|
|||
# 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: AdAvailabilityResult
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: IsAvailable
|
||||
summary: |
|
||||
An ad is available to show the user.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DeviceIneligible
|
||||
summary: |
|
||||
The device is ineligible to receive ads.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ExperienceIneligible
|
||||
summary: |
|
||||
The experience is ineligible to receive ads. Check if its eligibility has
|
||||
been revoked.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: InternalError
|
||||
summary: |
|
||||
An unspecified internal error occurred. Try fetching the ad again.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: NoFill
|
||||
summary: |
|
||||
There are no ads available to fill your ad request. You might have hit the
|
||||
ad frequency limit.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlayerIneligible
|
||||
summary: |
|
||||
The user is ineligible to receive ads during this session. The user might
|
||||
be under 13 or located in a blocked region.
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PublisherIneligible
|
||||
summary: |
|
||||
The publisher is ineligible to receive ads because they have not met the
|
||||
publisher eligibility requirements.
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
# 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: AdEventType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: VideoLoaded
|
||||
summary: ''
|
||||
value: 0
|
||||
tags:
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This option should not be used for new work.
|
||||
- name: VideoRemoved
|
||||
summary: ''
|
||||
value: 1
|
||||
tags:
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This option should not be used for new work.
|
||||
- name: UserCompletedVideo
|
||||
summary: ''
|
||||
value: 2
|
||||
tags:
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
This option should not be used for new work.
|
||||
- name: RewardedAdLoaded
|
||||
summary: |
|
||||
The event is fired when a click-to-play video ad is being served. This can
|
||||
be used to communicate and promote the reward to users through the UI or
|
||||
signage.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RewardedAdGrant
|
||||
summary: |
|
||||
The event is fired when a user has watched the click-to-play video ad for
|
||||
a certain time. This can be used to grant the player a reward such as an
|
||||
in-game item or in-game currency. The `RewardedAdGrant` enum will only be
|
||||
triggered once per ad rotation.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RewardedAdUnloaded
|
||||
summary: |
|
||||
The event is fired when a click-to-play video ad is rotated out. This can
|
||||
be used to remove any UI or signage that is promoting the reward.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,18 @@
|
|||
# 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: AdFormat
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: RewardedVideo
|
||||
summary: |
|
||||
The format of the rewarded video ad.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AdShape
|
||||
type: enum
|
||||
summary: |
|
||||
Describes the form factor of an ad in an `Class.AdGui`. There is currently
|
||||
only one available size.
|
||||
description: |
|
||||
Describes the form factor of an ad in an `Class.AdGui`. There is currently
|
||||
only one available size.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: HorizontalRectangle
|
||||
summary: |
|
||||
The ad has an aspect ratio of 16:9 and a minimum size of 8 by 4.5 studs.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: AdTeleportMethod
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Undefined
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PortalForward
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: InGameMenuBackButton
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UIBackButton
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
# 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: AdUIEventType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: AdLabelClicked
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: VolumeButtonClicked
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FullscreenButtonClicked
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlayButtonClicked
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PauseButtonClicked
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CloseButtonClicked
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WhyThisAdClicked
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlayEventTriggered
|
||||
summary: ''
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PauseEventTriggered
|
||||
summary: ''
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AdUIType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Image
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Video
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# 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: AdUnitStatus
|
||||
type: enum
|
||||
summary: |
|
||||
Exposes the status of an immersive ad.
|
||||
description: |
|
||||
Exposes the status of an immersive ad.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Inactive
|
||||
summary: |
|
||||
The ad unit isn't currently serving an ad and it may be configured
|
||||
incorrectly. An `Class.AdGui` with this status will display its fallback
|
||||
image.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Active
|
||||
summary: |
|
||||
The ad unit is currently serving an ad. Players will observe sponsored
|
||||
content in an `Class.AdGui` and an `Class.AdPortal` will teleport users
|
||||
that walk through.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# 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: AdornCullingMode
|
||||
type: enum
|
||||
summary: |
|
||||
Culling method used for adornments.
|
||||
description: |
|
||||
Used by `Class.HandleAdornment` to determine how it is culled.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Automatic
|
||||
summary: |
|
||||
Automatically culls adornment based on distance.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Never
|
||||
summary: |
|
||||
Never culls adornment. Adornment is always visible.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,63 @@
|
|||
# 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: AlignType
|
||||
type: enum
|
||||
summary: |
|
||||
An enum that specifies how the constraint will attempt to align the body
|
||||
associated with the constraint.
|
||||
description: |
|
||||
An enum that specifies how the constraint will attempt to align the body
|
||||
associated with the constraint and attachment. Depending on the configuration,
|
||||
it can be used to align specific axes to be parallel, perpendicular, or to
|
||||
look at a specific point.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Parallel
|
||||
summary: ''
|
||||
value: 0
|
||||
tags:
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
Use **PrimaryAxisParallel** instead.
|
||||
- name: Perpendicular
|
||||
summary: ''
|
||||
value: 1
|
||||
tags:
|
||||
- Deprecated
|
||||
deprecation_message: |
|
||||
Use **PrimaryAxisPerpendicular** instead.
|
||||
- name: PrimaryAxisParallel
|
||||
summary: |
|
||||
Aligns the primary axis to be parallel to the axis given by
|
||||
`Class.Constraint.Attachment1`.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PrimaryAxisPerpendicular
|
||||
summary: |
|
||||
Aligns the primary axis to be perpendicular to the axis given by
|
||||
`Class.Constraint.Attachment1`.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PrimaryAxisLookAt
|
||||
summary: |
|
||||
Aligns the primary axis to look at the point given by
|
||||
`Class.Constraint.Attachment1` or the
|
||||
`Class.AlignOrientation.LookAtPosition`.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AllAxes
|
||||
summary: |
|
||||
Aligns all of the axes of `Class.Constraint.Attachment0` to the axes given
|
||||
by `Class.Constraint.Attachment1` or to the target orientation provided by
|
||||
`Class.AlignOrientation.PrimaryAxis` and
|
||||
`Class.AlignOrientation.SecondaryAxis`.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,43 @@
|
|||
# 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: AlphaMode
|
||||
type: enum
|
||||
summary: |
|
||||
Used by `Class.SurfaceAppearance.AlphaMode` to determine how the alpha channel
|
||||
of the `Class.SurfaceAppearance.ColorMap` of a `Class.SurfaceAppearance` is
|
||||
used.
|
||||
description: |
|
||||
Used by `Class.SurfaceAppearance.AlphaMode` to determine how the alpha channel
|
||||
of the `Class.SurfaceAppearance.ColorMap` of a `Class.SurfaceAppearance` is
|
||||
used.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Overlay
|
||||
summary: |
|
||||
Overlays the `Class.SurfaceAppearance.ColorMap|ColorMap` on top of the
|
||||
underlying part color based on the map's alpha channel.
|
||||
|
||||
<img src="/assets/engine-api/enums/AlphaMode/Fern-Overlay.png" width="512" />
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Transparency
|
||||
summary: |
|
||||
Uses the `Class.SurfaceAppearance.ColorMap|ColorMap` alpha channel to
|
||||
control the transparency of the surface.
|
||||
|
||||
<img src="/assets/engine-api/enums/AlphaMode/Fern-Cutout.png" width="512" />
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TintMask
|
||||
summary: |
|
||||
Uses the `Class.SurfaceAppearance.ColorMap|ColorMap` alpha channel to
|
||||
control the amount of `Class.SurfaceAppearance.Color` tinting.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: AnalyticsCustomFieldKeys
|
||||
type: enum
|
||||
summary: |
|
||||
Used to form a dictionary of custom fields to provide breakdowns in
|
||||
Roblox-provided charts.
|
||||
description: |
|
||||
Used to form a dictionary of custom fields to provide breakdowns in
|
||||
Roblox-provided charts. For example:
|
||||
|
||||
```lua
|
||||
local customFields = {
|
||||
[Enum.AnalyticsCustomFieldKeys.CustomField01.Name] = "value1",
|
||||
[Enum.AnalyticsCustomFieldKeys.CustomField02.Name] = "value2",
|
||||
[Enum.AnalyticsCustomFieldKeys.CustomField03.Name] = "value3",
|
||||
}
|
||||
```
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: CustomField01
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomField02
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomField03
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# 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: AnalyticsEconomyAction
|
||||
type: enum
|
||||
summary: ''
|
||||
description: |
|
||||
This enum is used as an argument in
|
||||
`Class.AnalyticsService:FireInGameEconomyEvent()`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Default
|
||||
summary: |
|
||||
Default action. Used for an undefined Action.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Acquire
|
||||
summary: |
|
||||
Indicates the acquisition of an in game resource. For example, a player
|
||||
acquires virtual currency by completing a specific in game task.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Spend
|
||||
summary: |
|
||||
Indicates the spending or loss of an in game resource. For example, a
|
||||
player spends virtual currency to acquire a new item.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,24 @@
|
|||
# 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: AnalyticsEconomyFlowType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Sink
|
||||
summary: |
|
||||
Currency is being removed from the player's account.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Source
|
||||
summary: |
|
||||
Currency is being added to the player's account.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,54 @@
|
|||
# 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: AnalyticsEconomyTransactionType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: IAP
|
||||
summary: |
|
||||
Represents a source of currency purchased via Robux, for example
|
||||
in-experience "gold" purchased for Robux.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shop
|
||||
summary: |
|
||||
Purchases within a shop, for example in-experience "coins" used to buy an
|
||||
item within the experience.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Gameplay
|
||||
summary: |
|
||||
Currency earned or paid through gameplay, for example in-experience "gold"
|
||||
earned from winning a match.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ContextualPurchase
|
||||
summary: |
|
||||
Purchase with direct context to a reward, for example in-experience "gold"
|
||||
used to purchase an extra life.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TimedReward
|
||||
summary: |
|
||||
Time-based reward, for example in-experience "gold" rewarded for logging
|
||||
in daily.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Onboarding
|
||||
summary: |
|
||||
Transaction related to onboarding, for example in-experience "gold"
|
||||
rewarded for completing the tutorial.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,50 @@
|
|||
# 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: AnalyticsLogLevel
|
||||
type: enum
|
||||
summary: ''
|
||||
description: |
|
||||
This enum is used as an argument in `Class.AnalyticsService.LogEvent` to
|
||||
describe the error severity level.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Trace
|
||||
summary: |
|
||||
Trace is the noisiest level, rarely (if ever) enabled for a production
|
||||
app.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Debug
|
||||
summary: |
|
||||
Used for debugging.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Information
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Warning
|
||||
summary: |
|
||||
Used for warning.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Error
|
||||
summary: |
|
||||
When functionality is unavailable or expectations broken.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Fatal
|
||||
summary: |
|
||||
The most critical level, Fatal events demand immediate attention.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
# 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: AnalyticsProgressionStatus
|
||||
type: enum
|
||||
summary: |
|
||||
This enum is used as an argument in
|
||||
`Class.AnalyticsService:FirePlayerProgressionEvent()` to describe the status
|
||||
of progression.
|
||||
description: |
|
||||
This enum is used as an argument in
|
||||
`Class.AnalyticsService:FirePlayerProgressionEvent()` to describe the status
|
||||
of progression.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Default
|
||||
summary: |
|
||||
Default status. Used for an undefined status.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Begin
|
||||
summary: |
|
||||
Indicates the beginning of progression.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Complete
|
||||
summary: |
|
||||
Indicates the progression completed.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Abandon
|
||||
summary: |
|
||||
Indicates the progression abandoned.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Fail
|
||||
summary: |
|
||||
Indicates the progression failed.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: AnalyticsProgressionType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Custom
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Start
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Fail
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Complete
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,72 @@
|
|||
# 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: AnimationClipFromVideoStatus
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Initializing
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Pending
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Processing
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorGeneric
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Success
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorVideoTooLong
|
||||
summary: ''
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorNoPersonDetected
|
||||
summary: ''
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorVideoUnstable
|
||||
summary: ''
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Timeout
|
||||
summary: ''
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Cancelled
|
||||
summary: ''
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorMultiplePeople
|
||||
summary: ''
|
||||
value: 12
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorUploadingVideo
|
||||
summary: ''
|
||||
value: 2001
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,83 @@
|
|||
# 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: AnimationPriority
|
||||
type: enum
|
||||
summary: |
|
||||
The AnimationPriority Enum determines how concurrently-playing AnimationTracks
|
||||
contribute to the final animation.
|
||||
description: |
|
||||
When multiple `Class.AnimationTrack|AnimationTracks` are played concurrently
|
||||
by the same `Class.Animator` and affect the same animated joints, the tracks
|
||||
are evaluated in order from high to low priority, per joint, while the total
|
||||
track weight sum remains less than 1.0. When the track weight sum reaches or
|
||||
exceeds 1.0 for a joint, evaluation stops and no lower-priority tracks will be
|
||||
evaluated for that joint. `Class.AnimationTrack|AnimationTracks` with the same
|
||||
priority that are playing concurrently will blend proportional to their track
|
||||
weights (normalized if the sum exceeds 1).
|
||||
|
||||
Higher priority animation will override lower priority ones per joint. The
|
||||
priority order is:
|
||||
|
||||
1. **Action4**
|
||||
2. **Action3**
|
||||
3. **Action2**
|
||||
4. **Action**
|
||||
5. **Movement**
|
||||
6. **Idle**
|
||||
7. **Core**
|
||||
|
||||
Roblox's default character animations, including catalog animation bundles,
|
||||
play at **Core** priority. **Idle** through **Action4** priority are for
|
||||
developer use.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Idle
|
||||
summary: |
|
||||
(6) - Recommended priority for character idle animations.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Movement
|
||||
summary: |
|
||||
(5) - Recommended priority for walk, run, swim, climb, and other
|
||||
locomotion animations.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Action
|
||||
summary: |
|
||||
(4) - Recommended priority for character actions that must override idle
|
||||
and locomotion animations.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Action2
|
||||
summary: |
|
||||
(3) - Action2 will override Action.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Action3
|
||||
summary: |
|
||||
(2) - Action3 will override Action2.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Action4
|
||||
summary: |
|
||||
(1) - Action4 is the highest priority available, overriding all other
|
||||
priority values.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Core
|
||||
summary: |
|
||||
(7) - Lowest priority, intended for use by Roblox default animations and
|
||||
catalog animation bundles.
|
||||
value: 1000
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# 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: AnimatorRetargetingMode
|
||||
type: enum
|
||||
summary: |
|
||||
Animation Retargeting setting.
|
||||
description: |
|
||||
The AnimatorRetargetingMode Enum describes the setting for Animation
|
||||
Retargeting. Retargeting adapts animations to various character rigs based on
|
||||
their proportions.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Default
|
||||
summary: |
|
||||
Retargeting in default state, opt-in initially but subject to change.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Disabled
|
||||
summary: |
|
||||
Retargeting disabled.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Enabled
|
||||
summary: |
|
||||
Retargeting enabled.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AnnotationEditingMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlacingNew
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WritingNew
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: AnnotationRequestStatus
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Success
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Loading
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorInternalFailure
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorNotFound
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ErrorModerated
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: AnnotationRequestType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Unknown
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Create
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Resolve
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Delete
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Edit
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: AppLifecycleManagerState
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Detached
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Active
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Inactive
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Hidden
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
# 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: AppShellActionType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: OpenApp
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TapChatTab
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TapConversationEntry
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TapAvatarTab
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ReadConversation
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TapGamePageTab
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TapHomePageTab
|
||||
summary: ''
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: GamePageLoaded
|
||||
summary: ''
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: HomePageLoaded
|
||||
summary: ''
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AvatarEditorPageLoaded
|
||||
summary: ''
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# 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: AppShellFeature
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Chat
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AvatarEditor
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: GamePage
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: HomePage
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: More
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Landing
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,47 @@
|
|||
# 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: AppUpdateStatus
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Unknown
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: NotSupported
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Failed
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: NotAvailable
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Available
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AvailableBoundChannel
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AvailableBetaProgram
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# 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: ApplyStrokeMode
|
||||
type: enum
|
||||
summary: |
|
||||
Used by `Class.UIStroke.ApplyStrokeMode` to determine where to apply the
|
||||
stroke.
|
||||
description: |
|
||||
This enum is used by `Class.UIStroke.ApplyStrokeMode` to determine whether to
|
||||
apply the stroke to the object's border or of the text itself. For a more
|
||||
detailed walkthrough of the UIStroke object, see Applying Strokes.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Contextual
|
||||
summary: |
|
||||
The stroke is applied to the parent UI element's text.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Border
|
||||
summary: |
|
||||
The stroke is applied to the parent UI element's border.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# 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: AspectType
|
||||
type: enum
|
||||
summary: |
|
||||
Used by `Class.UIAspectRatioConstraint.AspectType` to control sizing behavior.
|
||||
description: |
|
||||
Used by `Class.UIAspectRatioConstraint.AspectType` to control sizing behavior.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: FitWithinMaxSize
|
||||
summary: |
|
||||
The object will be the maximum size possible within its own
|
||||
`Class.GuiBase2d.AbsoluteSize|AbsoluteSize`.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ScaleWithParentSize
|
||||
summary: |
|
||||
The object's maximum size will be the size of the parent while still
|
||||
maintaining the aspect ratio.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AssetCreatorType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: User
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Group
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,46 @@
|
|||
# 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: AssetFetchStatus
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Success
|
||||
summary: |
|
||||
The asset loaded successfully.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Failure
|
||||
summary: |
|
||||
The asset failed to load successfully. Subsequent attempts are likely to
|
||||
fail; there may be something wrong with the `Datatype.Content|Content`
|
||||
string.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: None
|
||||
summary: |
|
||||
The engine has no information about this asset. The engine never tried to
|
||||
load it.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Loading
|
||||
summary: |
|
||||
The engine is in the middle of trying to load this asset.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TimedOut
|
||||
summary: |
|
||||
The engine tried to load this asset but timed out. Future attempts to load
|
||||
may succeed.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
369
.cursor/rules/roblox/en-us/reference/engine/enums/AssetType.yaml
Normal file
369
.cursor/rules/roblox/en-us/reference/engine/enums/AssetType.yaml
Normal file
|
|
@ -0,0 +1,369 @@
|
|||
# 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: AssetType
|
||||
type: enum
|
||||
summary: |
|
||||
This Enum can be used to match the AssetTypeId from
|
||||
`Class.MarketplaceService:GetProductInfoAsync()` to an asset type.
|
||||
description: |
|
||||
This Enum can be used to match the AssetTypeId from
|
||||
`Class.MarketplaceService:GetProductInfoAsync()` to an asset type.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Image
|
||||
summary: |
|
||||
The asset is an image.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TShirt
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Audio
|
||||
summary: |
|
||||
The asset is an audio clip.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Mesh
|
||||
summary: |
|
||||
The asset is a mesh.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Lua
|
||||
summary: |
|
||||
The asset is Luau code, for example a `Class.ModuleScript`.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Hat
|
||||
summary: |
|
||||
The asset is a hat.
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Place
|
||||
summary: |
|
||||
The asset is a place.
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Model
|
||||
summary: |
|
||||
The asset is a model.
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shirt
|
||||
summary: |
|
||||
The asset is a shirt.
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Pants
|
||||
summary: |
|
||||
The asset is a pants item.
|
||||
value: 12
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Decal
|
||||
summary: |
|
||||
The asset is a decal (image).
|
||||
value: 13
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Head
|
||||
summary: |
|
||||
The asset is a head.
|
||||
value: 17
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Face
|
||||
summary: |
|
||||
The asset is a face.
|
||||
value: 18
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Gear
|
||||
summary: |
|
||||
The asset is a gear item.
|
||||
value: 19
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Badge
|
||||
summary: |
|
||||
The asset is a badge.
|
||||
value: 21
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Animation
|
||||
summary: |
|
||||
The asset is an animation; also see the more specific animation type enums
|
||||
below.
|
||||
value: 24
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Torso
|
||||
summary: |
|
||||
The asset is a torso.
|
||||
value: 27
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightArm
|
||||
summary: |
|
||||
The asset is a right arm.
|
||||
value: 28
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftArm
|
||||
summary: |
|
||||
The asset is a left arm.
|
||||
value: 29
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftLeg
|
||||
summary: |
|
||||
The asset is a left leg.
|
||||
value: 30
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightLeg
|
||||
summary: |
|
||||
The asset is a right leg.
|
||||
value: 31
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Package
|
||||
summary: |
|
||||
The asset is a pack, for example an animation package.
|
||||
value: 32
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: GamePass
|
||||
summary: |
|
||||
The asset is a GamePass.
|
||||
value: 34
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Plugin
|
||||
summary: |
|
||||
The asset is a plugin.
|
||||
value: 38
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: MeshPart
|
||||
summary: |
|
||||
The asset is a mesh part.
|
||||
value: 40
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: HairAccessory
|
||||
summary: |
|
||||
The asset is a hair accessory.
|
||||
value: 41
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FaceAccessory
|
||||
summary: |
|
||||
The asset is a face accessory.
|
||||
value: 42
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: NeckAccessory
|
||||
summary: |
|
||||
The asset is a neck accessory.
|
||||
value: 43
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ShoulderAccessory
|
||||
summary: |
|
||||
The asset is a shoulder accessory.
|
||||
value: 44
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FrontAccessory
|
||||
summary: |
|
||||
The asset is a front accessory.
|
||||
value: 45
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: BackAccessory
|
||||
summary: |
|
||||
The asset is a back accessory.
|
||||
value: 46
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WaistAccessory
|
||||
summary: |
|
||||
The asset is a waist accessory.
|
||||
value: 47
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ClimbAnimation
|
||||
summary: |
|
||||
The asset is a climb animation.
|
||||
value: 48
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DeathAnimation
|
||||
summary: |
|
||||
The asset is a death animation.
|
||||
value: 49
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FallAnimation
|
||||
summary: |
|
||||
The asset is a fall animation.
|
||||
value: 50
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: IdleAnimation
|
||||
summary: |
|
||||
The asset is an idle animation.
|
||||
value: 51
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: JumpAnimation
|
||||
summary: |
|
||||
The asset is a jump animation.
|
||||
value: 52
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RunAnimation
|
||||
summary: |
|
||||
The asset is a run animation.
|
||||
value: 53
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SwimAnimation
|
||||
summary: |
|
||||
The asset is a swim animation.
|
||||
value: 54
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WalkAnimation
|
||||
summary: |
|
||||
The asset is a walk animation.
|
||||
value: 55
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PoseAnimation
|
||||
summary: |
|
||||
The asset is a pose animation.
|
||||
value: 56
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EarAccessory
|
||||
summary: ''
|
||||
value: 57
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyeAccessory
|
||||
summary: ''
|
||||
value: 58
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EmoteAnimation
|
||||
summary: |
|
||||
The asset is an emote animation.
|
||||
value: 61
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Video
|
||||
summary: |
|
||||
The asset is a video.
|
||||
value: 62
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TShirtAccessory
|
||||
summary: ''
|
||||
value: 64
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ShirtAccessory
|
||||
summary: ''
|
||||
value: 65
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PantsAccessory
|
||||
summary: ''
|
||||
value: 66
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: JacketAccessory
|
||||
summary: ''
|
||||
value: 67
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SweaterAccessory
|
||||
summary: ''
|
||||
value: 68
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ShortsAccessory
|
||||
summary: ''
|
||||
value: 69
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftShoeAccessory
|
||||
summary: ''
|
||||
value: 70
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightShoeAccessory
|
||||
summary: ''
|
||||
value: 71
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DressSkirtAccessory
|
||||
summary: ''
|
||||
value: 72
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FontFamily
|
||||
summary: ''
|
||||
value: 73
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyebrowAccessory
|
||||
summary: ''
|
||||
value: 76
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyelashAccessory
|
||||
summary: ''
|
||||
value: 77
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: MoodAnimation
|
||||
summary: ''
|
||||
value: 78
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DynamicHead
|
||||
summary: ''
|
||||
value: 79
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FaceMakeup
|
||||
summary: ''
|
||||
value: 88
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LipMakeup
|
||||
summary: ''
|
||||
value: 89
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyeMakeup
|
||||
summary: ''
|
||||
value: 90
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: AssetTypeVerification
|
||||
type: enum
|
||||
summary: |
|
||||
Determines the asset type verification mode.
|
||||
description: |
|
||||
Determines the asset type verification mode used when calling
|
||||
`Class.Humanoid:ApplyDescriptionAsync()` or
|
||||
`Class.Players:CreateHumanoidModelFromDescriptionAsync()`. This verification
|
||||
mode determines if the method will load models or not. Loading models can be
|
||||
insecure if it's possible for malicious users to trick your game into loading
|
||||
unexpected models that you own which may include malicious scripts. You should
|
||||
set this to `Always` unless you want to load non-catalog assets.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Default
|
||||
summary: |
|
||||
Use the default behavior for asset type verification.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ClientOnly
|
||||
summary: |
|
||||
Only verify asset types on the client. Asset type verification can not be
|
||||
turned off on the client.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Always
|
||||
summary: |
|
||||
Always verify the asset types to be loaded and disallow loading models.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: AudioApiRollout
|
||||
type: enum
|
||||
summary: |
|
||||
Used to determine whether voice chat is represented and controlled by
|
||||
`Class.AudioDeviceInput` objects.
|
||||
description: |
|
||||
Used to determine whether voice chat is represented and controlled by
|
||||
`Class.AudioDeviceInput` objects.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Disabled
|
||||
summary: |
|
||||
Voice chat will use an internal voice chat implementation that is
|
||||
automatic and hidden.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Automatic
|
||||
summary: |
|
||||
Currently means the same thing as `Disabled`, but will be updated to mean
|
||||
`Enabled` in the future.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Enabled
|
||||
summary: |
|
||||
Voice chat can be customized or controlled via
|
||||
`Class.AudioDeviceInput|AudioDeviceInputs`.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
# 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: AudioCaptureMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items: []
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
# 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: AudioChannelLayout
|
||||
type: enum
|
||||
summary: |
|
||||
Describes the channel layout of an audio stream.
|
||||
description: |
|
||||
The `AudioChannelLayout` enum describes the channel layout of an audio stream.
|
||||
Audio streams contain one or more channels that are intended to be rendered
|
||||
simultaneously with a particular arrangement of speakers. In general, more
|
||||
channels impact performance but provide higher spatial quality.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Mono
|
||||
summary: |
|
||||
Monaural audio streams contain only one **Center** channel.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Mono.jpg" width="810" alt="Diagram showing position of channels for Mono layout." />
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Stereo
|
||||
summary: |
|
||||
Stereophonic audio streams consist of two channels: **Left** and
|
||||
**Right**.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Stereo.jpg" width="810" alt="Diagram showing position of channels for Stereo layout." />
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Quad
|
||||
summary: |
|
||||
Quadrophonic audio streams consist of four channels: **Left**, **Right**,
|
||||
**BackLeft**, and **BackRight**. Quadrophonic streams can encode
|
||||
forward/backward spatial information that stereo streams might struggle
|
||||
with.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Quad.jpg" width="810" alt="Diagram showing position of channels for Quad layout." />
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Surround_5
|
||||
summary: |
|
||||
Surround sound audio streams consist of five channels: **Left**,
|
||||
**Right**, **Center**, **BackLeft**, and **BackRight**. Surround sound
|
||||
streams encode spatial information with better resolution front and
|
||||
center.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_5.jpg" width="810" alt="Diagram showing position of channels for Surround 5 layout." />
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Surround_5_1
|
||||
summary: |
|
||||
5.1 surround sound consists of six channels: **Left**, **Right**,
|
||||
**Center**, **BackLeft**, **BackRight**, and a **Sub** (subsonic)
|
||||
low‑frequency channel. 5.1 surround sound benefits from low frequencies
|
||||
being less directional in order to encode higher resolution spatial
|
||||
information versus simple 5‑channel surround sound.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_5_1.jpg" width="810" alt="Diagram showing position of channels for Surround 5.1 layout." />
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Surround_7_1
|
||||
summary: |
|
||||
7.1 surround sound consists of eight channels: **Left**, **Right**,
|
||||
**Center**, **SurroundLeft**, **SurroundRight**, **BackLeft**,
|
||||
**BackRight**, and a **Sub** (subsonic) low‑frequency channel. 7.1
|
||||
surround sound is an improvement over 5.1 surround sound, offering better
|
||||
spatial resolution directly to the left and right as well.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_7_1.jpg" width="810" alt="Diagram showing position of channels for Surround 7.1 layout." />
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Surround_7_1_4
|
||||
summary: |
|
||||
7.1.4 surround sound consists of twelve channels: **Left**, **Right**,
|
||||
**Center**, **SurroundLeft**, **SurroundRight**, **BackLeft**,
|
||||
**BackRight**, **Sub**, **TopLeft**, **TopRight**, **TopBackLeft**, and
|
||||
**TopBackRight**. 7.1.4 is the only currently supported channel layout
|
||||
that encodes height information.
|
||||
|
||||
<img src="/assets/engine-api/enums/AudioChannelLayout/Surround_7_1_4.jpg" width="810" alt="Diagram showing position of channels for Surround 7.1.4 layout." />
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
# 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: AudioFilterType
|
||||
type: enum
|
||||
summary: |
|
||||
Filter types used for `Class.AudioFilter` instances.
|
||||
description: |
|
||||
Families of curves that `Class.AudioFilter` can use to process incoming audio.
|
||||
Each filter type is applied at a specified
|
||||
`Class.AudioFilter.Frequency|Frequency` and may be shaped by additional
|
||||
`Class.AudioFilter.Gain|Gain` or `Class.AudioFilter.Q|Q` parameters.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Peak
|
||||
summary: |
|
||||
Filter that boosts or reduces sound near a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LowShelf
|
||||
summary: |
|
||||
Filter that boosts or reduces sound below a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: HighShelf
|
||||
summary: |
|
||||
Filter that boosts or reduces sound above a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Lowpass12dB
|
||||
summary: |
|
||||
Filter that cuts sound above a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`, at a slope of -12dB/octave.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Lowpass24dB
|
||||
summary: |
|
||||
Filter that cuts sound above a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`, at a slope of -24dB/octave.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Lowpass48dB
|
||||
summary: |
|
||||
Filter that cuts sound above a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`, at a slope of -48dB/octave.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Highpass12dB
|
||||
summary: |
|
||||
Filter that cuts sound below a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`, at a slope of -12dB/octave.
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Highpass24dB
|
||||
summary: |
|
||||
Filter that cuts sound below a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`, at a slope of -24dB/octave.
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Highpass48dB
|
||||
summary: |
|
||||
Filter that cuts sound below a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`, at a slope of -48dB/octave.
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Bandpass
|
||||
summary: |
|
||||
Filter that only allows sound near a specified
|
||||
`Class.AudioFilter.Frequency|Frequency` to be heard.
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Notch
|
||||
summary: |
|
||||
Filter that cuts sound near a specified
|
||||
`Class.AudioFilter.Frequency|Frequency`.
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Lowpass6dB
|
||||
summary: ''
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,31 @@
|
|||
# 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: AudioSimulationFidelity
|
||||
type: enum
|
||||
summary: |
|
||||
Enum which determines how detailed audio simulation should be for
|
||||
`Class.AudioEmitter|AudioEmitters` and `Class.AudioListener|AudioListeners`.
|
||||
description: |
|
||||
This enum, used with `Class.AudioEmitter.SimulationFidelity` and
|
||||
`Class.AudioListener.SimulationFidelity`, determines how detailed audio
|
||||
simulation should be.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: |
|
||||
No acoustic simulation occurs; only direction and distance are taken into
|
||||
account.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Automatic
|
||||
summary: |
|
||||
The audio engine simulates transmission, diffraction, and reflections at a
|
||||
level of detail suitable to most devices.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AudioSubType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Music
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SoundEffect
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AudioWindowSize
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Small
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Medium
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Large
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,28 @@
|
|||
# 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: AuthorityMode
|
||||
type: enum
|
||||
summary: |
|
||||
Enum used with `Class.Workspace.AuthorityMode`.
|
||||
description: |
|
||||
Enum used with `Class.Workspace.AuthorityMode`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Server
|
||||
summary: |
|
||||
Server authority with client side prediction and rollback enabled.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Automatic
|
||||
summary: |
|
||||
Traditional distributed authority model where, for each instance, the
|
||||
engine decides whether the server or a client should be the authority;
|
||||
`Class.BasePart:SetNetworkOwner()` can be used to influence the decision.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AutoIndentRule
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: 'Off'
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Absolute
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Relative
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# 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: AutomaticSize
|
||||
type: enum
|
||||
summary: |
|
||||
UI objects with `Class.GuiObject.AutomaticSize|AutomaticSize` enabled will
|
||||
increase in size up to maximum size allowed by the parent (if there is one)
|
||||
and no smaller than the `Class.GuiObject.Size|Size` property bounds.
|
||||
description: |
|
||||
UI objects with `Class.GuiObject.AutomaticSize|AutomaticSize` enabled will
|
||||
increase in size up to maximum size allowed by the parent (if there is one)
|
||||
and no smaller than the `Class.GuiObject.Size|Size` property bounds. To enable
|
||||
`Enum.AutomaticSize`, set the value to an enum value other than `None`.
|
||||
|
||||
This enum is used by `Class.GuiObject.AutomaticSize` and
|
||||
`Class.ScrollingFrame.AutomaticCanvasSize` to determine whether and how
|
||||
resizing occurs based on child content.
|
||||
|
||||
For more information, see
|
||||
[Automatic Sizing](../../../ui/size-modifiers.md#automatic-sizing).
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: |
|
||||
Default sizing behavior.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: X
|
||||
summary: |
|
||||
Automatically resize element along X-axis to fit child contents.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: 'Y'
|
||||
summary: |
|
||||
Automatically resize element along Y-axis to fit child contents. Text
|
||||
Objects will only resize along the Y-axis if TextWrapped is enabled.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: XY
|
||||
summary: |
|
||||
Automatically resize element along X and Y axes to fit child contents.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,266 @@
|
|||
# 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: AvatarAssetType
|
||||
type: enum
|
||||
summary: |
|
||||
Describes the asset types that an avatar can equip.
|
||||
description: |
|
||||
Describes the asset types that an avatar can equip. See `Enum.AssetType` for
|
||||
all asset types.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: TShirt
|
||||
summary: |
|
||||
A classic 2D TShirt.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Hat
|
||||
summary: |
|
||||
A hat.
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shirt
|
||||
summary: |
|
||||
A classic 2D shirt.
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Pants
|
||||
summary: |
|
||||
A classic 2D pants.
|
||||
value: 12
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Head
|
||||
summary: |
|
||||
A head.
|
||||
value: 17
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Face
|
||||
summary: |
|
||||
A face.
|
||||
value: 18
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Gear
|
||||
summary: |
|
||||
A gear.
|
||||
value: 19
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Torso
|
||||
summary: |
|
||||
A torso.
|
||||
value: 27
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightArm
|
||||
summary: |
|
||||
A right arm.
|
||||
value: 28
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftArm
|
||||
summary: |
|
||||
A left arm.
|
||||
value: 29
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftLeg
|
||||
summary: |
|
||||
A left leg.
|
||||
value: 30
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightLeg
|
||||
summary: |
|
||||
A right leg.
|
||||
value: 31
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: HairAccessory
|
||||
summary: |
|
||||
A hair accessory.
|
||||
value: 41
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FaceAccessory
|
||||
summary: |
|
||||
A face accessory.
|
||||
value: 42
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: NeckAccessory
|
||||
summary: |
|
||||
A neck accessory.
|
||||
value: 43
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ShoulderAccessory
|
||||
summary: |
|
||||
A shoulder accessory.
|
||||
value: 44
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FrontAccessory
|
||||
summary: |
|
||||
A front accessory.
|
||||
value: 45
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: BackAccessory
|
||||
summary: |
|
||||
A back accessory.
|
||||
value: 46
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WaistAccessory
|
||||
summary: |
|
||||
A waist accessory.
|
||||
value: 47
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ClimbAnimation
|
||||
summary: |
|
||||
A climb animation.
|
||||
value: 48
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FallAnimation
|
||||
summary: |
|
||||
A fall animation.
|
||||
value: 50
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: IdleAnimation
|
||||
summary: |
|
||||
An idle animation.
|
||||
value: 51
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: JumpAnimation
|
||||
summary: |
|
||||
A jump animation.
|
||||
value: 52
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RunAnimation
|
||||
summary: |
|
||||
A run animation.
|
||||
value: 53
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SwimAnimation
|
||||
summary: |
|
||||
A swim animation.
|
||||
value: 54
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WalkAnimation
|
||||
summary: |
|
||||
A walk animation.
|
||||
value: 55
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EmoteAnimation
|
||||
summary: |
|
||||
An emote animation.
|
||||
value: 61
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: TShirtAccessory
|
||||
summary: |
|
||||
A layered clothing TShirt.
|
||||
value: 64
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ShirtAccessory
|
||||
summary: |
|
||||
A layered clothing shirt.
|
||||
value: 65
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PantsAccessory
|
||||
summary: |
|
||||
A layered clothing pants.
|
||||
value: 66
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: JacketAccessory
|
||||
summary: |
|
||||
A layered clothing jacket.
|
||||
value: 67
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SweaterAccessory
|
||||
summary: |
|
||||
A layered clothing sweater.
|
||||
value: 68
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ShortsAccessory
|
||||
summary: |
|
||||
A layered clothing shorts.
|
||||
value: 69
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftShoeAccessory
|
||||
summary: |
|
||||
A layered clothing left shoe.
|
||||
value: 70
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightShoeAccessory
|
||||
summary: |
|
||||
A layered clothing right shoe.
|
||||
value: 71
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DressSkirtAccessory
|
||||
summary: |
|
||||
A layered clothing dress or skirt.
|
||||
value: 72
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyebrowAccessory
|
||||
summary: ''
|
||||
value: 76
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyelashAccessory
|
||||
summary: ''
|
||||
value: 77
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: MoodAnimation
|
||||
summary: ''
|
||||
value: 78
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DynamicHead
|
||||
summary: ''
|
||||
value: 79
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FaceMakeup
|
||||
summary: ''
|
||||
value: 88
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LipMakeup
|
||||
summary: ''
|
||||
value: 89
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EyeMakeup
|
||||
summary: ''
|
||||
value: 90
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
# 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: AvatarChatServiceFeature
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UniverseAudio
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UniverseVideo
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlaceAudio
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlaceVideo
|
||||
summary: ''
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserAudioEligible
|
||||
summary: ''
|
||||
value: 16
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserAudio
|
||||
summary: ''
|
||||
value: 32
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserVideoEligible
|
||||
summary: ''
|
||||
value: 64
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserVideo
|
||||
summary: ''
|
||||
value: 128
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserBanned
|
||||
summary: ''
|
||||
value: 256
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserVerifiedForVoice
|
||||
summary: ''
|
||||
value: 512
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: AvatarContextMenuOption
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Friend
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Chat
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Emote
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: InspectMenu
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# 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: AvatarItemType
|
||||
type: enum
|
||||
summary: |
|
||||
The type (Asset or Bundle) of avatar items.
|
||||
description: |
|
||||
The type (Asset or Bundle) of avatar items.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Asset
|
||||
summary: |
|
||||
Avatar assets.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Bundle
|
||||
summary: |
|
||||
Avatar bundles.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: AvatarPromptResult
|
||||
type: enum
|
||||
summary: |
|
||||
The result of prompt operations of `Class.AvatarEditorService`.
|
||||
description: |
|
||||
The result of prompt operations of `Class.AvatarEditorService`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Success
|
||||
summary: |
|
||||
The prompted action was completed.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PermissionDenied
|
||||
summary: |
|
||||
Denied permission to take the prompted action.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Failed
|
||||
summary: |
|
||||
Failure while trying to take the prompted action.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: AvatarSettingsAccessoryLimitMethod
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Scale
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Remove
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PreviewScale
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PreviewRemove
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsAccessoryMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomLimit
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsAnimationClipsMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomClips
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AvatarSettingsAnimationPacksMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: StandardR15
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: StandardR6
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AvatarSettingsAppearanceMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomParts
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomBody
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsBuildMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomBuild
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsClothingMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomLimit
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AvatarSettingsCollisionMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Default
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SingleCollider
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Legacy
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsCustomAccessoryMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomAccessories
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsCustomBodyType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: AvatarReference
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: BundleId
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsCustomClothingMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomClothing
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsHitAndTouchDetectionMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: UseParts
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UseCollider
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsJumpMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: JumpHeight
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: JumpPower
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsLegacyCollisionMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: R6Colliders
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: InnerBoxColliders
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarSettingsScaleMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: PlayerChoice
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CustomScale
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: AvatarThumbnailCustomizationType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Closeup
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FullBody
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: AvatarUnificationMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Default
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Disabled
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Enabled
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
33
.cursor/rules/roblox/en-us/reference/engine/enums/Axis.yaml
Normal file
33
.cursor/rules/roblox/en-us/reference/engine/enums/Axis.yaml
Normal file
|
|
@ -0,0 +1,33 @@
|
|||
# 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: Axis
|
||||
type: enum
|
||||
summary: |
|
||||
One of the 3D axes.
|
||||
description: |
|
||||
The Axis Enum represents the X, Y and Z axes. Primarily this Enum is used with
|
||||
`Class.ArcHandles` and `Class.Handles`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: X
|
||||
summary: |
|
||||
The X axis.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: 'Y'
|
||||
summary: |
|
||||
The Y axis.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Z
|
||||
summary: |
|
||||
The Z axis.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: BenefitType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: DeveloperProduct
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AvatarAsset
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AvatarBundle
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: BinType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: |
|
||||
This deprecated Enum is used by `Class.HopperBin` which has also been
|
||||
deprecated. Neither should be used in new work.
|
||||
items:
|
||||
- name: Script
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: GameTool
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Grab
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Clone
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Hammer
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,51 @@
|
|||
# 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: BodyPart
|
||||
type: enum
|
||||
summary: |
|
||||
The BodyPart Enum determines which BodyPart a `Class.CharacterMesh` affects.
|
||||
description: |
|
||||
The BodyPart Enum determines which BodyPart a `Class.CharacterMesh` affects.
|
||||
(the `Class.CharacterMesh` is used with R6 characters)
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Head
|
||||
summary: |
|
||||
The head BodyPart.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Torso
|
||||
summary: |
|
||||
The torso BodyPart.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftArm
|
||||
summary: |
|
||||
The left arm BodyPart.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightArm
|
||||
summary: |
|
||||
The right arm BodyPart.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftLeg
|
||||
summary: |
|
||||
The left leg BodyPart.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightLeg
|
||||
summary: |
|
||||
The right leg BodyPart.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,119 @@
|
|||
# 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: BodyPartR15
|
||||
type: enum
|
||||
summary: |
|
||||
BodyPartR15 is an enum with entries for each of the 15 body parts of an R15
|
||||
character (plus an entry for the HumanoidRootPart).
|
||||
description: |
|
||||
BodyPartR15 is an Enum used with both `Class.Humanoid:GetBodyPartR15()` and
|
||||
`Class.Humanoid:ReplaceBodyPartR15()` to find and replace specific body parts
|
||||
of R15 characters.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Head
|
||||
summary: |
|
||||
Reference to a Humanoid's Head.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UpperTorso
|
||||
summary: |
|
||||
Reference to a Humanoid's UpperTorso.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LowerTorso
|
||||
summary: |
|
||||
Reference to a Humanoid's LowerTorso.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftFoot
|
||||
summary: |
|
||||
Reference to a Humanoid's LeftFoot.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftLowerLeg
|
||||
summary: |
|
||||
Reference to a Humanoid's LeftLowerLeg.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftUpperLeg
|
||||
summary: |
|
||||
Reference to a Humanoid's LeftUpperLeg.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightFoot
|
||||
summary: |
|
||||
Reference to a Humanoid's RightFoot.
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightLowerLeg
|
||||
summary: |
|
||||
Reference to a Humanoid's RightLowerLeg.
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightUpperLeg
|
||||
summary: |
|
||||
Reference to a Humanoid's RightUpperLeg.
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftHand
|
||||
summary: |
|
||||
Reference to a Humanoid's LeftHand.
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftLowerArm
|
||||
summary: |
|
||||
Reference to a Humanoid's LeftLowerArm.
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LeftUpperArm
|
||||
summary: |
|
||||
Reference to a Humanoid's LeftUpperArm.
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightHand
|
||||
summary: |
|
||||
Reference to a Humanoid's RightHand.
|
||||
value: 12
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightLowerArm
|
||||
summary: |
|
||||
Reference to a Humanoid's RightLowerArm.
|
||||
value: 13
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RightUpperArm
|
||||
summary: |
|
||||
Reference to a Humanoid's RightUpperArm.
|
||||
value: 14
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RootPart
|
||||
summary: |
|
||||
Reference to a Humanoid's HumanoidRootPart.
|
||||
value: 15
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Unknown
|
||||
summary: |
|
||||
Unknown R15 Humanoid body part.
|
||||
value: 17
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: BorderMode
|
||||
type: enum
|
||||
summary: |
|
||||
Used by `Class.GuiObject.BorderMode` to determine where borders are placed.
|
||||
description: |
|
||||
Determines in what matter the border of a `Class.GuiObject` is laid out
|
||||
relative to its actual dimensions. It is used by the property of the same
|
||||
name, `Class.GuiObject.BorderMode`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Outline
|
||||
summary: |
|
||||
As `Class.GuiObject.BorderSizePixel` increases, the border grows outward.
|
||||
The dimensions of the GuiObject's contents do not change.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Middle
|
||||
summary: |
|
||||
As `Class.GuiObject.BorderSizePixel` increases, the border grows evenly
|
||||
inward and outward. The dimensions of the GuiObject's contents are reduced
|
||||
at a 1:1 ratio.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Inset
|
||||
summary: |
|
||||
As `Class.GuiObject.BorderSizePixel` increases, the border grows evenly
|
||||
inward only. The dimensions of the GuiObject's contents are reduced at a
|
||||
1:2 ratio.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: BorderStrokePosition
|
||||
type: enum
|
||||
summary: |
|
||||
Used by `Class.UIStroke.BorderStrokePosition` to determine the stroke's
|
||||
position on its parent's border.
|
||||
description: |
|
||||
Used by `Class.UIStroke.BorderStrokePosition` to determine the stroke's
|
||||
position on its parent's border.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Outer
|
||||
summary: |
|
||||
The stroke renders on the outer border of the parent UI
|
||||
element.<br /><br /><img src="../../../assets/ui/ui-objects/UIStroke-BorderStrokePosition-Outer.png" width="312" />
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Center
|
||||
summary: |
|
||||
The stroke renders on the center border of the parent UI
|
||||
element.<br /><br /><img src="../../../assets/ui/ui-objects/UIStroke-BorderStrokePosition-Center.png" width="312" />
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Inner
|
||||
summary: |
|
||||
The stroke renders on the inner border of the parent UI
|
||||
element.<br /><br /><img src="../../../assets/ui/ui-objects/UIStroke-BorderStrokePosition-Inner.png" width="312" />
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: BreakReason
|
||||
type: enum
|
||||
summary: |
|
||||
Reason for the breakpoint hit.
|
||||
description: |
|
||||
Value for the reason the `Class.ScriptDebugger.EncounteredBreak` signal fired.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Other
|
||||
summary: |
|
||||
Pausing for a reason not covered by other values, for example if the user
|
||||
hit "Pause" button.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Error
|
||||
summary: |
|
||||
Pausing on error hit in the code.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: SpecialBreakpoint
|
||||
summary: |
|
||||
Pausing on an internal breakpoint set by debugger command: e.g. step over,
|
||||
step into, step out of.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: UserBreakpoint
|
||||
summary: |
|
||||
Pausing on a user breakpoint.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: BreakpointRemoveReason
|
||||
type: enum
|
||||
summary: |
|
||||
Reason that a breakpoint was removed.
|
||||
description: |
|
||||
Reason that a breakpoint was removed.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Requested
|
||||
summary: |
|
||||
Breakpoint removal was requested by user or a command.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ScriptChanged
|
||||
summary: |
|
||||
Script that contained the breakpoint has changed.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ScriptRemoved
|
||||
summary: |
|
||||
Script that contained the breakpoint was removed.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: BulkMoveMode
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: FireAllEvents
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: FireCFrameChanged
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,44 @@
|
|||
# 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: BundleType
|
||||
type: enum
|
||||
summary: |
|
||||
The type of a bundle of assets.
|
||||
description: |
|
||||
The type of a bundle of assets.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: BodyParts
|
||||
summary: |
|
||||
A bundle of body parts and accessories.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Animations
|
||||
summary: |
|
||||
A bundle of just animations.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Shoes
|
||||
summary: |
|
||||
A bundle of left shoe and right shoe.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DynamicHead
|
||||
summary: |
|
||||
A bundle consisting of dynamicHead and moodAnimation assets, optionally
|
||||
with eyebrowAccessory and eyelashAccessory.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: DynamicHeadAvatar
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,26 @@
|
|||
# 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: Button
|
||||
type: enum
|
||||
summary: |
|
||||
One of the buttons used by `Class.Controller`.
|
||||
description: |
|
||||
Used for accessing buttons for use by the `Class.Controller`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Dismount
|
||||
summary: |
|
||||
The Dismount button.
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Jump
|
||||
summary: |
|
||||
The Jump button.
|
||||
value: 32
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,57 @@
|
|||
# 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: ButtonStyle
|
||||
type: enum
|
||||
summary: |
|
||||
Used by `Class.GuiButton.Style` to set a special hardcoded appearance.
|
||||
description: |
|
||||
Used by `Class.GuiButton.Style` to set a special hardcoded appearance.
|
||||
|
||||
These should generally be avoided in favor of setting other appearance
|
||||
properties, but they can be useful for wireframing.
|
||||
|
||||
Despite the Roblox naming, these are not used by any official Roblox UI.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Custom
|
||||
summary: |
|
||||
The button will respect the `Class.GuiObject.BorderColor3` and
|
||||
`Class.GuiObject.BackgroundColor3` properties.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RobloxButtonDefault
|
||||
summary: |
|
||||
A black background with a red border, and rounded corners.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RobloxButton
|
||||
summary: |
|
||||
A black background with a grey border, and rounded corners.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RobloxRoundButton
|
||||
summary: |
|
||||
A grey background with rounded corners, and a slight drop shadow.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RobloxRoundDefaultButton
|
||||
summary: |
|
||||
A blue background with rounded corners, and a slight drop shadow.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RobloxRoundDropdownButton
|
||||
summary: |
|
||||
A white background with a thin grey border, rounded corners, and a slight
|
||||
drop shadow.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: CageType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Inner
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Outer
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
# 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: CameraMode
|
||||
type: enum
|
||||
summary: |
|
||||
Used to set `Class.Player.CameraMode` to determine when first person and third
|
||||
person cameras should be used.
|
||||
description: |
|
||||
The **CameraMode** enum is used to set `Class.Player.CameraMode` to determine
|
||||
when first person and third person cameras should be used.
|
||||
|
||||
#### Third Person
|
||||
|
||||
In the default third person mode (`Enum.CameraMode|Classic`), the character
|
||||
can be seen in the camera. While in this mode, the default behavior is:
|
||||
|
||||
- Players can right-click and drag (mouse), tap and drag (mobile), use the
|
||||
secondary thumbstick (gamepad), or press the left/right arrows (keyboard) to
|
||||
rotate the camera around their character.
|
||||
- When a player moves their character, it faces in the corresponding movement
|
||||
direction.
|
||||
- Players can zoom in and out freely, even to first person on full zoom in.
|
||||
|
||||
#### First Person
|
||||
|
||||
In first person mode (`Enum.CameraMode|LockFirstPerson`), the player's camera
|
||||
is zoomed all the way in. Unless there is a visible GUI present with the
|
||||
`Class.GuiButton.Modal` property set to `true`, moving the mouse, tap-dragging
|
||||
on mobile, or using the secondary thumbstick on a gamepad will rotate the
|
||||
camera around the character.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Classic
|
||||
summary: |
|
||||
Third person camera which can be zoomed into first person.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: LockFirstPerson
|
||||
summary: |
|
||||
Exclusively first person camera.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,30 @@
|
|||
# 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: CameraPanMode
|
||||
type: enum
|
||||
summary: |
|
||||
The CameraPanMode Enum represents the available pan modes for
|
||||
`Class.Camera:SetCameraPanMode()`.
|
||||
description: |
|
||||
The CameraPanMode Enum represents the available pan modes for
|
||||
`Class.Camera:SetCameraPanMode()`.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Classic
|
||||
summary: |
|
||||
Enables swipe and pan on mobile devices, and disables edge bump camera
|
||||
controls. Default.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: EdgeBump
|
||||
summary: |
|
||||
Disables swipe to pan on mobile devices, and enables edge bump camera
|
||||
controls. It does not affect Windows or Mac users.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,27 @@
|
|||
# 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: CameraSpeedAdjustBinding
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RmbScroll
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AltScroll
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
# 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: CameraType
|
||||
type: enum
|
||||
summary: |
|
||||
Describes the camera behavior mode if using the default PlayerScripts.
|
||||
description: |
|
||||
The CameraType Enum is used in `Class.Camera.CameraType` to set the behavior
|
||||
of the Camera object.
|
||||
|
||||
Attach, Watch, Track, and Follow all require a valid
|
||||
`Class.Camera.CameraSubject` to work properly.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Fixed
|
||||
summary: |
|
||||
Camera is stationary.
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Attach
|
||||
summary: |
|
||||
Camera moves with the subject at a fixed offset and will rotate as the
|
||||
subject rotates.
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Watch
|
||||
summary: |
|
||||
Camera is stationary but will rotate to keep the subject in the center of
|
||||
the screen.
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Track
|
||||
summary: |
|
||||
Camera moves with the subject but does not rotate automatically.
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Follow
|
||||
summary: |
|
||||
Camera moves with the subject and rotates to keep the subject in the
|
||||
center.
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Custom
|
||||
summary: |
|
||||
Default mode used by Roblox core scripts.
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Scriptable
|
||||
summary: |
|
||||
No default behavior. Used when developers need to script custom behavior.
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Orbital
|
||||
summary: |
|
||||
The camera has a fixed Y position, but can be rotated around the player.
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
# 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: CaptureGalleryPermission
|
||||
type: enum
|
||||
summary: ''
|
||||
description: |
|
||||
Used to specify the scope of permissions for accessing the user's capture
|
||||
gallery.
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: ReadAndUpload
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
# 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: CaptureType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Screenshot
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Video
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
# 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: CatalogCategoryFilter
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: None
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Featured
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Collectibles
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CommunityCreations
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Premium
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Recommended
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
# 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: CatalogSortAggregation
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Past12Hours
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PastDay
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Past3Days
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PastWeek
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PastMonth
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: AllTime
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,42 @@
|
|||
# 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: CatalogSortType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: Relevance
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PriceHighToLow
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PriceLowToHigh
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: MostFavorited
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RecentlyCreated
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Bestselling
|
||||
summary: ''
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -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: CellBlock
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: |
|
||||
This enum is deprecated. It used to work with `Class.Terrain:SetCell()` - a
|
||||
function that is no longer supported by the `Class.Terrain` engine.
|
||||
items:
|
||||
- name: Solid
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: VerticalWedge
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CornerWedge
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: InverseCornerWedge
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: HorizontalWedge
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,104 @@
|
|||
# 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: CellMaterial
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: |
|
||||
This enum is deprecated. It used to work with the legacy `Class.Terrain`
|
||||
engine to set the material of terrain cells.
|
||||
items:
|
||||
- name: Empty
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Grass
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Sand
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Brick
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Granite
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Asphalt
|
||||
summary: ''
|
||||
value: 5
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Iron
|
||||
summary: ''
|
||||
value: 6
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Aluminum
|
||||
summary: ''
|
||||
value: 7
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Gold
|
||||
summary: ''
|
||||
value: 8
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WoodPlank
|
||||
summary: ''
|
||||
value: 9
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: WoodLog
|
||||
summary: ''
|
||||
value: 10
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Gravel
|
||||
summary: ''
|
||||
value: 11
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: CinderBlock
|
||||
summary: ''
|
||||
value: 12
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: MossyStone
|
||||
summary: ''
|
||||
value: 13
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Cement
|
||||
summary: ''
|
||||
value: 14
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: RedPlastic
|
||||
summary: ''
|
||||
value: 15
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: BluePlastic
|
||||
summary: ''
|
||||
value: 16
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Water
|
||||
summary: ''
|
||||
value: 17
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
# 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: CellOrientation
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: |
|
||||
This enum is deprecated. It used to work with the legacy `Class.Terrain`
|
||||
engine to set the orientation of terrain cells.
|
||||
items:
|
||||
- name: NegZ
|
||||
summary: ''
|
||||
value: 0
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: X
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: Z
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: NegX
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
# 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: CenterDialogType
|
||||
type: enum
|
||||
summary: ''
|
||||
description: ''
|
||||
code_samples: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
items:
|
||||
- name: UnsolicitedDialog
|
||||
summary: ''
|
||||
value: 1
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: PlayerInitiatedDialog
|
||||
summary: ''
|
||||
value: 2
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: ModalDialog
|
||||
summary: ''
|
||||
value: 3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
- name: QuitDialog
|
||||
summary: ''
|
||||
value: 4
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue