hakowork/rojo
3
0
Fork 0
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-10-24 06:34:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update rules

Browse source
This commit is contained in:
Joe 2026-02-17 06:30:42 -06:00
parent 31350cd701
commit cc2c828757
156 changed files with 4981 additions and 1497 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.cursor/rules/roblox/en-us/reference/engine/classes/AdGui.yaml
View file

@ -50,6 +50,7 @@ properties:
can_save: true
capabilities:
- UI
- Monetization
- name: AdGui.FallbackImage
summary: ''
description: ''
@ -86,6 +87,7 @@ properties:
can_save: false
capabilities:
- UI
- Monetization
methods: []
events: []
callbacks:
@ -115,4 +117,5 @@ callbacks:
thread_safety: Unsafe
capabilities:
- UI
- Monetization
writeCapabilities: []

22
.cursor/rules/roblox/en-us/reference/engine/classes/AdService.yaml
View file

@ -39,7 +39,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Monetization
- name: AdService:GetAdAvailabilityNowAsync
summary: |
Checks if a video ad is available to be played to the current user inside
@ -63,7 +64,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Monetization
- name: AdService:RegisterAdOpportunityAsync
summary: |
Tracks how many times a user had the chance to watch a video ad and the
@ -91,7 +93,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Monetization
- name: AdService:ShowRewardedVideoAdAsync
summary: |
Plays the video ad to the current user inside the experience.
@ -126,7 +129,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Monetization
- name: AdService:ShowVideoAd
summary: |
Show mobile video advertisements.
@ -144,7 +149,8 @@ methods:
no longer operational.
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Monetization
- name: AdService:UnregisterAdOpportunity
summary: ''
description: ''
@ -161,7 +167,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Monetization
events:
- name: AdService.VideoAdClosed
summary: |
@ -180,5 +187,6 @@ events:
`Class.AdService.VideoAdClosed|VideoAdClosed` has been decommissioned and
is no longer operational.
security: None
capabilities: []
capabilities:
- Monetization
callbacks: []

16
.cursor/rules/roblox/en-us/reference/engine/classes/AnalyticsService.yaml
View file

@ -121,7 +121,8 @@ methods:
summary: ''
tags:
- Deprecated
deprecation_message: ''
deprecation_message: |
This deprecated property is a variant of `Class.AnalyticsService:LogCustomEvent()` which should be used instead.
security: None
thread_safety: Unsafe
capabilities:
@ -179,10 +180,9 @@ methods:
This function has been deprecated in favor of more descriptive methods,
including:
- `Class.AnalyticsService:FireCustomEvent()`
- `Class.AnalyticsService:FireInGameEconomyEvent()`
- `Class.AnalyticsService:FireLogEvent()`
- `Class.AnalyticsService:FirePlayerProgressionEvent()`
- `Class.AnalyticsService:LogCustomEvent()`
- `Class.AnalyticsService:LogEconomyEvent()`
- `Class.AnalyticsService:LogProgressionEvent()`
security: None
thread_safety: Unsafe
capabilities:
@ -302,7 +302,8 @@ methods:
No return.
tags:
- Deprecated
deprecation_message: ''
deprecation_message: |
This deprecated property is a variant of `Class.AnalyticsService:LogEconomyEvent()` which should be used instead.
security: None
thread_safety: Unsafe
capabilities:
@ -540,7 +541,8 @@ methods:
No return.
tags:
- Deprecated
deprecation_message: ''
deprecation_message: |
This deprecated property is a variant of `Class.AnalyticsService:LogProgressionEvent()` which should be used instead.
security: None
thread_safety: Unsafe
capabilities:

49
.cursor/rules/roblox/en-us/reference/engine/classes/AudioDeviceInput.yaml
View file

@ -51,7 +51,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput.Active
summary: |
Controls whether the physical device is actively recording.
@ -73,7 +75,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput.IsReady
summary: |
Denotes whether this `Class.AudioDeviceInput` is ready to produce sound.
@ -94,7 +98,9 @@ properties:
serialization:
can_load: false
can_save: true
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput.Muted
summary: |
Controls whether this `Class.AudioDeviceInput` is muted.
@ -119,7 +125,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput.Player
summary: |
Determines whose device is producing sound.
@ -140,7 +148,10 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Input
- Players
- name: AudioDeviceInput.Volume
summary: |
Volume level which is multiplied onto the output audio stream.
@ -159,7 +170,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Input
methods:
- name: AudioDeviceInput:GetConnectedWires
summary: |
@ -183,7 +196,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput:GetInputPins
summary: |
Gets the list of pins that `Class.Wire` can use in `Class.Wire.TargetName`
@ -203,7 +218,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput:GetOutputPins
summary: |
Gets the list of pins that `Class.Wire` can use in `Class.Wire.SourceName`
@ -223,7 +240,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput:GetUserIdAccessList
summary: |
Returns a list of user IDs that are either permitted to hear or blocked
@ -241,7 +260,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Audio
- Input
- name: AudioDeviceInput:SetUserIdAccessList
summary: |
Sets a list of user IDs that are either permitted to hear or blocked from
@ -266,7 +287,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Audio
- Input
events:
- name: AudioDeviceInput.WiringChanged
summary: |
@ -302,5 +325,7 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- Audio
- Input
callbacks: []

3
.cursor/rules/roblox/en-us/reference/engine/classes/AudioSpeechToText.yaml
View file

@ -14,7 +14,8 @@ description: |
Roblox uses the following formula to throttle requests for this API based on
the number of players in your experience:
`max requests per minute per experience = 1 + (5 * number_of_concurrent_users)`.
`max requests per minute per experience = 1 + (5 * number_of_concurrent_users)`. You can purchase additional usage using
[Extended Services](../../../cloud-services/extended-services.md).
For more information, see
[Speech-to-text](../../../audio/objects.md#speech-to-text).

34
.cursor/rules/roblox/en-us/reference/engine/classes/AvatarCreationService.yaml
View file

@ -71,7 +71,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- DynamicGeneration
- name: AvatarCreationService:GenerateAvatar2DPreviewAsync
summary: |
Creates a 2D avatar preview and returns a previewId.
@ -119,7 +120,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- DynamicGeneration
- name: AvatarCreationService:GenerateAvatarAsync
summary: |
Generates an avatar and returns a generationId.
@ -165,7 +167,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- DynamicGeneration
- name: AvatarCreationService:GetBatchTokenDetailsAsync
summary: |
Gets the avatar creation token details for a list of avatar creation
@ -208,7 +211,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Monetization
- name: AvatarCreationService:GetValidationRules
summary: |
Gets data regarding rules that assets must abide by to pass UGC
@ -400,7 +404,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- DynamicGeneration
- name: AvatarCreationService:LoadGeneratedAvatarAsync
summary: |
Loads a generated avatar using an avatar generation ID.
@ -441,7 +446,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- DynamicGeneration
- name: AvatarCreationService:PrepareAvatarForPreviewAsync
summary: |
Prepares in-experience avatar for preview.
@ -475,7 +481,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Avatar
- name: AvatarCreationService:PromptCreateAvatarAssetAsync
summary: |
Prompts a `Class.Player` to purchase and create an avatar asset from an
@ -668,7 +675,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetCreateUpdate
- Monetization
- name: AvatarCreationService:PromptSelectAvatarGenerationImageAsync
summary: |
Prompt the `Class.Player` to take a selfie and return the FileId.
@ -709,7 +718,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- SensitiveInput
- name: AvatarCreationService:RequestAvatarGenerationSessionAsync
summary: |
Request an AvatarGeneration session for a `Class.Player`.
@ -779,7 +789,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- DynamicGeneration
- name: AvatarCreationService:ValidateUGCAccessoryAsync
summary: |
Studio only. Runs UGC validation for an `Enum.AccessoryType`.
@ -976,5 +987,6 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- DynamicGeneration
callbacks: []

100
.cursor/rules/roblox/en-us/reference/engine/classes/AvatarEditorService.yaml
View file

@ -393,7 +393,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Avatar
- name: AvatarEditorService:CheckApplyDefaultClothing
summary: |
Used to apply default clothing to the `Class.HumanoidDescription` if
@ -417,7 +418,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Avatar
- name: AvatarEditorService:ConformToAvatarRulesAsync
summary: ''
description: ''
@ -435,7 +437,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Avatar
- name: AvatarEditorService:ConformToAvatarRules
summary: ''
description: ''
@ -454,7 +457,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Avatar
- name: AvatarEditorService:GetAccessoryType
summary: ''
description: ''
@ -587,7 +591,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetBatchItemDetails
summary: |
Gets the item details for a list of items at once.
@ -616,7 +621,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetFavoriteAsync
summary: |
Returns if the `Class.Players.LocalPlayer` has favorited the given bundle
@ -645,7 +651,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:GetFavorite
summary: |
Returns if the `Class.Players.LocalPlayer` has favorited the given bundle
@ -673,7 +681,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:GetInventoryAsync
summary: |
Returns an `Class.InventoryPages` object with information about owned
@ -711,7 +721,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:GetInventory
summary: |
Returns an `Class.InventoryPages` object with information about owned
@ -734,7 +746,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:GetItemDetailsAsync
summary: |
Returns the item details for the given item.
@ -800,7 +814,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetItemDetails
summary: |
Returns the item details for the given item.
@ -829,7 +844,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetOutfitDetailsAsync
summary: |
Returns the outfit details for the given outfit.
@ -892,7 +908,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetOutfitDetails
summary: |
Returns the outfit details for the given outfit.
@ -915,7 +932,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetOutfitsAsync
summary: |
Returns outfit data for the `Class.Players.LocalPlayer`.
@ -983,7 +1001,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:GetOutfits
summary: |
Returns outfit data for the `Class.Players.LocalPlayer`.
@ -1007,7 +1027,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:GetRecommendedAssetsAsync
summary: |
Returns a list of recommended assets based on a given `Enum.AssetType` and
@ -1073,7 +1095,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetRecommendedAssets
summary: |
Returns a list of recommended assets based on a given `Enum.AssetType` and
@ -1105,7 +1128,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetRecommendedBundlesAsync
summary: |
Returns a list of recommended bundles for a given bundle id.
@ -1164,7 +1188,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:GetRecommendedBundles
summary: |
Returns a list of recommended bundles for a given bundle id.
@ -1186,7 +1211,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:PromptAllowInventoryReadAccess
summary: |
Prompts the `Class.Players.LocalPlayer` to allow the developer to read
@ -1209,7 +1235,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService:PromptCreateOutfit
summary: |
Prompts the `Class.Players.LocalPlayer` to save the given
@ -1239,7 +1267,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- PlatformAvatarEditing
- name: AvatarEditorService:PromptDeleteOutfit
summary: |
Prompts the `Class.Players.LocalPlayer` to delete the given outfit.
@ -1261,7 +1291,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- PlatformAvatarEditing
- name: AvatarEditorService:PromptRenameOutfit
summary: |
Prompts the `Class.Players.LocalPlayer` to rename the given outfit.
@ -1283,7 +1315,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- PlatformAvatarEditing
- name: AvatarEditorService:PromptSaveAvatar
summary: |
Prompts the `Class.Players.LocalPlayer` to update their avatar based on
@ -1345,7 +1379,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- PlatformAvatarEditing
- name: AvatarEditorService:PromptUpdateOutfit
summary: |
Prompts the `Class.Players.LocalPlayer` to update the given outfit.
@ -1376,7 +1412,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- PlatformAvatarEditing
- name: AvatarEditorService:SearchCatalogAsync
summary: |
Returns a `Class.CatalogPages` object containing the result of the given
@ -1403,7 +1441,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
- name: AvatarEditorService:SearchCatalog
summary: |
Returns a `Class.CatalogPages` object containing the result of the given
@ -1425,7 +1464,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- AssetRead
events:
- name: AvatarEditorService.PromptAllowInventoryReadAccessCompleted
summary: |
@ -1448,7 +1488,9 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- Players
- AssetRead
- name: AvatarEditorService.PromptCreateOutfitCompleted
summary: |
Fires when the PromptSaveOutfit operation is completed.

2
.cursor/rules/roblox/en-us/reference/engine/classes/ChangeHistoryService.yaml
View file

@ -46,7 +46,7 @@ methods:
Identifies the recording from the previous call to
`Class.ChangeHistoryService:TryBeginRecording()|TryBeginRecording()`.
If the operation is
`Enum.ChangeHistoryService.FinishRecordingOperation.Cancel`, this
`Enum.FinishRecordingOperation.Cancel`, this
value is ignored, and the recording is determined by context.
- name: operation
type: FinishRecordingOperation

12
.cursor/rules/roblox/en-us/reference/engine/classes/ExperienceNotificationService.yaml
View file

@ -61,7 +61,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- Social
- name: ExperienceNotificationService:PromptOptIn
summary: |
Shows an in-experience prompt for the local player to enable
@ -95,7 +97,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- Social
events:
- name: ExperienceNotificationService.OptInPromptClosed
summary: |
@ -117,5 +121,7 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- Players
- Social
callbacks: []

27
.cursor/rules/roblox/en-us/reference/engine/classes/Explosion.yaml
View file

@ -97,7 +97,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.BlastRadius
summary: |
This property determines the radius of the `Class.Explosion`, in studs.
@ -133,7 +134,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.DestroyJointRadiusPercent
summary: |
Used to set the proportion of the `Class.Explosion.BlastRadius`, between 0
@ -168,7 +170,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.ExplosionType
summary: |
This property determines how the `Class.Explosion` will interact with
@ -201,7 +204,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.LocalTransparencyModifier
summary: ''
description: ''
@ -219,7 +223,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.Position
summary: |
This property is the position of the center of the `Class.Explosion`. It
@ -256,7 +261,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.TimeScale
summary: |
Value between 0 and 1 that controls the speed of the particle effect.
@ -276,7 +282,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
- name: Explosion.Visible
summary: |
This property determines whether or not the visual effect of an
@ -305,7 +312,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
methods: []
events:
- name: Explosion.Hit
@ -349,5 +357,6 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- AvatarBehavior
callbacks: []

3
.cursor/rules/roblox/en-us/reference/engine/classes/ForceField.yaml
View file

@ -71,7 +71,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- AvatarBehavior
methods: []
events: []
callbacks: []

103
.cursor/rules/roblox/en-us/reference/engine/classes/GuiService.yaml
View file

@ -44,7 +44,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- UI
- Input
- name: GuiService.CoreGuiNavigationEnabled
summary: |
Toggles whether or not objects in the `Class.CoreGui` can be navigated
@ -66,7 +68,9 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- Input
- name: GuiService.GuiNavigationEnabled
summary: |
Used to enable and disable the default controller GUI navigation.
@ -84,7 +88,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- UI
- Input
- name: GuiService.IsModalDialog
summary: |
Indicates whether a modal dialog is visible.
@ -107,7 +113,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- name: GuiService.IsWindows
summary: |
Indicates whether the user is playing on a computer running Windows.
@ -130,7 +137,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- name: GuiService.MenuIsOpen
summary: |
Returns `true` if any menu of `Class.CoreGui` is open.
@ -150,7 +158,8 @@ properties:
serialization:
can_load: false
can_save: true
capabilities: []
capabilities:
- UI
- name: GuiService.PreferredTextSize
summary: |
Gets the player's preferred text size as an `Enum.PreferredTextSize`
@ -211,7 +220,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- name: GuiService.PreferredTransparency
summary: |
Gets the player's preferred transparency as a number between `0` and `1`.
@ -247,7 +257,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- name: GuiService.ReducedMotionEnabled
summary: |
Returns `true` if the player has enabled reduced motion.
@ -273,7 +284,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- name: GuiService.SelectedObject
summary: |
Sets the `Class.GuiObject` currently being focused on by the GUI
@ -299,7 +311,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- UI
- Input
- name: GuiService.TopbarInset
summary: |
Used to determine the absolute size and position of unobstructed area
@ -330,7 +344,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- name: GuiService.TouchControlsEnabled
summary: |
Used to enable and disable touch controls and touch control display UI.
@ -350,7 +365,9 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
- Input
- name: GuiService.ViewportDisplaySize
summary: |
Read-only property which represents the physical rendering size of the
@ -375,7 +392,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- UI
methods:
- name: GuiService:AddSelectionParent
summary: |
@ -406,7 +424,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:AddSelectionTuple
summary: |
**AddSelectionTuple** works similarly to
@ -449,7 +468,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:CloseInspectMenu
summary: |
Closes the avatar inspection menu, if open.
@ -476,7 +496,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:DismissNotification
summary: ''
description: ''
@ -493,7 +514,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:GetEmotesMenuOpen
summary: |
Checks if the player emotes menu is open.
@ -511,7 +533,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:GetGameplayPausedNotificationEnabled
summary: |
Returns whether or not the `Class.Player.GameplayPaused` notification has
@ -534,7 +557,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:GetGuiInset
summary: |
Returns two `Datatype.Vector2` values representing the inset of user GUIs
@ -559,7 +583,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:GetInspectMenuEnabled
summary: |
Returns whether the avatar inspection menu is enabled.
@ -579,7 +604,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:InspectPlayerFromHumanoidDescription
summary: |
Allows the avatar inspection menu to appear showing the assets listed in a
@ -615,7 +641,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Avatar
- name: GuiService:InspectPlayerFromUserId
summary: |
Allows the avatar inspection menu to appear showing the user that has the
@ -645,7 +673,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Avatar
- name: GuiService:IsTenFootInterface
summary: |
Returns `true` if the client is using the ten foot interface, a special
@ -666,7 +696,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:RemoveSelectionGroup
summary: |
Removes a group that was created with
@ -690,7 +721,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:Select
summary: |
Sets `Class.GuiService.SelectedObject` to a child of a provided instance
@ -716,7 +748,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:SendNotification
summary: ''
description: ''
@ -733,7 +766,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:SetEmotesMenuOpen
summary: |
Opens or closes the player emotes menu.
@ -752,7 +786,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:SetGameplayPausedNotificationEnabled
summary: |
Lets you disable the built-in notification when a player's gameplay is
@ -781,7 +816,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- name: GuiService:SetInspectMenuEnabled
summary: |
Allows you to enable or disable the avatar inspection menu.
@ -803,7 +839,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
events:
- name: GuiService.MenuClosed
summary: |
@ -815,7 +852,8 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- UI
- name: GuiService.MenuOpened
summary: |
Fires when the user **opens** the Roblox `Class.CoreGui` escape menu.
@ -826,5 +864,6 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- UI
callbacks: []

55
.cursor/rules/roblox/en-us/reference/engine/classes/Humanoid.yaml
View file

@ -85,6 +85,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.AutomaticScalingEnabled
summary: |
When Enabled, AutomaticScalingEnabled causes the size of the character to
@ -165,6 +166,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.BreakJointsOnDeath
summary: |
Determines whether the humanoid's joints break when in the
@ -186,6 +188,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.CameraOffset
summary: |
An offset applied to the Camera's subject position when its CameraSubject
@ -214,6 +217,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.CollisionType
summary: |
Selects the `Enum.HumanoidCollisionType` for R15 and Rthro non-player
@ -360,6 +364,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.FloorMaterial
summary: |
Describes the `Enum.Material` that the `Class.Humanoid` is currently
@ -412,6 +417,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Health
summary: |
Describes the current health of the Humanoid on the range [0,
@ -469,6 +475,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.HealthDisplayDistance
summary: |
Used in conjunction with the
@ -600,6 +607,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.JumpHeight
summary: |
Provides control over the height that the `Class.Humanoid` jumps to.
@ -631,6 +639,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.JumpPower
summary: |
Determines how much upwards force is applied to the `Class.Humanoid` when
@ -666,6 +675,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.LeftLeg
summary: |
A reference to the humanoid's _Left Leg_ part.
@ -717,6 +727,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.maxHealth
summary: ''
description: ''
@ -767,6 +778,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.MoveDirection
summary: |
Describes the direction that the `Class.Humanoid` is walking in.
@ -794,6 +806,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.NameDisplayDistance
summary: |
Used in conjunction with the `Class.Humanoid.DisplayDistanceType` property
@ -878,6 +891,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.RequiresNeck
summary: |
Allows developers to disable the behavior where a player
@ -901,6 +915,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.RightLeg
summary: |
A reference to the humanoid's _Right Leg_ part.
@ -984,6 +999,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.SeatPart
summary: |
A reference to the seat that a `Class.Humanoid` is currently sitting in,
@ -1014,6 +1030,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Sit
summary: |
Describes whether the `Class.Humanoid` is currently sitting.
@ -1045,6 +1062,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.TargetPoint
summary: |
Describes the 3D position where the `Class.Player` controlling the
@ -1076,6 +1094,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Torso
summary: |
A reference to a humanoid's root driving part.
@ -1128,6 +1147,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.WalkSpeed
summary: |
Describes the humanoid's maximum movement speed in studs per second.
@ -1168,6 +1188,7 @@ properties:
can_save: true
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.WalkToPart
summary: |
A reference to a part whose position is trying to be reached by a
@ -1204,6 +1225,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.WalkToPoint
summary: |
The position that a humanoid is trying to reach, after a call to
@ -1235,6 +1257,7 @@ properties:
can_save: false
capabilities:
- Avatar
- AvatarBehavior
methods:
- name: Humanoid:AddAccessory
summary: |
@ -1522,6 +1545,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:ChangeState
summary: |
Sets the `Class.Humanoid` to enter the given `Enum.HumanoidStateType`.
@ -1572,6 +1596,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:EquipTool
summary: |
Makes the `Class.Humanoid` equip the given `Class.Tool`.
@ -1602,6 +1627,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:GetAccessories
summary: |
Returns an array of `Class.Accessory` objects that the humanoid's parent
@ -1701,6 +1727,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:GetLimb
summary: |
Returns the `Enum.Limb` enum that is associated with the given
@ -1740,6 +1767,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:GetMoveVelocity
summary: ''
description: ''
@ -1754,6 +1782,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:GetPlayingAnimationTracks
summary: |
Returns an array of all `Class.AnimationTrack|AnimationTracks` that are
@ -1805,6 +1834,7 @@ methods:
thread_safety: Safe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:GetStateEnabled
summary: |
Returns whether a `Enum.HumanoidStateType` is enabled for the
@ -1844,6 +1874,7 @@ methods:
thread_safety: Safe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:GetStatuses
summary: |
Returns a table of the Humanoid's statuses, and custom statuses.
@ -2016,6 +2047,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:MoveTo
summary: |
Causes the `Class.Humanoid` to attempt to walk to the given location by
@ -2076,6 +2108,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:PlayEmoteAsync
summary: |
Plays emotes and returns if was successfully ran.
@ -2101,6 +2134,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:PlayEmote
summary: |
Plays emotes and returns if was successfully ran.
@ -2126,6 +2160,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:RemoveAccessories
summary: |
Removes all `Class.Accessory` objects worn by the humanoid's parent.
@ -2276,6 +2311,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:TakeDamage
summary: |
Lowers the `Class.Humanoid.Health` of the `Class.Humanoid` by the given
@ -2323,6 +2359,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid:takeDamage
summary: ''
description: ''
@ -2372,6 +2409,7 @@ methods:
thread_safety: Unsafe
capabilities:
- Avatar
- AvatarBehavior
events:
- name: Humanoid.AnimationPlayed
summary: |
@ -2458,6 +2496,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.CustomStatusAdded
summary: |
Fired when a status is added to the Humanoid.
@ -2520,6 +2559,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.FallingDown
summary: |
Fires when the `Class.Humanoid` enters or leaves the `FallingDown`
@ -2545,6 +2585,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.FreeFalling
summary: |
Fires when the `Class.Humanoid` enters or leaves the `Freefall`
@ -2574,6 +2615,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.GettingUp
summary: |
Fires when the `Class.Humanoid` enters or leaves the `GettingUp`
@ -2605,6 +2647,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.HealthChanged
summary: |
Fires when the `Class.Humanoid.Health` changes (or when the
@ -2631,6 +2674,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Jumping
summary: |
Fires when the `Class.Humanoid` enters and leaves the `Jumping`
@ -2660,6 +2704,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.MoveToFinished
summary: |
Fires when the `Class.Humanoid` finishes walking to a goal declared by
@ -2693,6 +2738,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.PlatformStanding
summary: |
Fires when the `Class.Humanoid` enters or leaves the `PlatformStanding`
@ -2724,6 +2770,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Ragdoll
summary: |
Fires when the `Class.Humanoid` enters or leaves the `Ragdoll`
@ -2755,6 +2802,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Running
summary: |
Fires when the speed at which a `Class.Humanoid` is running changes.
@ -2787,6 +2835,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Seated
summary: |
Fired when a `Class.Humanoid` either sits in a `Class.Seat` or
@ -2828,6 +2877,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.StateChanged
summary: |
Fires when the state of the `Class.Humanoid` is changed.
@ -2865,6 +2915,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.StateEnabledChanged
summary: |
Fires when `Class.Humanoid:SetStateEnabled()` is called on the
@ -2901,6 +2952,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.StatusAdded
summary: |
Fired when a status is added to the Humanoid.
@ -2977,6 +3029,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Swimming
summary: |
Fires when the speed at which a `Class.Humanoid` is swimming in
@ -3011,6 +3064,7 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
- name: Humanoid.Touched
summary: |
Fires when one of the humanoid's limbs come in contact with another
@ -3063,4 +3117,5 @@ events:
security: None
capabilities:
- Avatar
- AvatarBehavior
callbacks: []

121
.cursor/rules/roblox/en-us/reference/engine/classes/InputBinding.yaml
View file

@ -5,8 +5,9 @@
name: InputBinding
type: class
memory_category: Instances
summary: Defines which hardware binding should trigger the parent `Class.InputAction`.
description: |-
summary: |
Defines which hardware binding should trigger the parent `Class.InputAction`.
description: |
An `InputBinding` defines which hardware binding should trigger the parent
`Class.InputAction`, for example a key press, gamepad button, or tap on a
touch‑enabled device. There can be multiple `InputBinding` instances parented
@ -19,10 +20,10 @@ tags: []
deprecation_message: ''
properties:
- name: InputBinding.Backward
summary: |-
summary: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally
"backward" inputs to the parent `Class.InputAction`.
description: |-
description: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally
"backward" inputs to `Class.InputAction:GetState()|GetState()` and the
`Class.InputAction.StateChanged|StateChanged` event of the parent
@ -45,10 +46,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Down
summary: |-
summary: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally "down"
inputs to the parent `Class.InputAction`.
description: |-
description: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally "down"
inputs to `Class.InputAction:GetState()|GetState()` and the
`Class.InputAction.StateChanged|StateChanged` event of the parent
@ -85,10 +86,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Forward
summary: |-
summary: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally
"forward" inputs to the parent `Class.InputAction`.
description: |-
description: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally
"forward" inputs to `Class.InputAction:GetState()|GetState()` and the
`Class.InputAction.StateChanged|StateChanged` event of the parent
@ -111,10 +112,10 @@ properties:
capabilities:
- Input
- name: InputBinding.KeyCode
summary: |-
summary: |
Specifies the `Enum.KeyCode` which triggers the parent
`Class.InputAction`.
description: |-
description: |
Specifies the `Enum.KeyCode` which triggers the parent
`Class.InputAction`. The code type should match the input action's
`Class.InputAction.Type|Type`, for example `Enum.KeyCode.E` for an action
@ -138,10 +139,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Left
summary: |-
summary: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally "left"
inputs to the parent `Class.InputAction`.
description: |-
description: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally "left"
inputs to `Class.InputAction:GetState()|GetState()` and the
`Class.InputAction.StateChanged|StateChanged` event of the parent
@ -174,10 +175,10 @@ properties:
capabilities:
- Input
- name: InputBinding.PressedThreshold
summary: |-
summary: |
Numerical value above which to fire an `Class.InputAction` with a
`Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`.
description: |-
description: |
Numerical value above which to fire an `Class.InputAction` with a
`Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`, for example
when a gamepad trigger such as `Enum.KeyCode.ButtonL2` exceeds `0.5`
@ -201,15 +202,21 @@ properties:
capabilities:
- Input
- name: InputBinding.PrimaryModifier
summary: Specifies a primary `Enum.KeyCode` that must be pressed for the binding to activate.
description: |-
Specifies a `Enum.KeyCode` that serves as a required modifier for the binding. The `Class.InputBinding`
will only trigger the parent `Class.InputAction` if this input is pressed prior to
`Class.InputBinding.KeyCode|KeyCode`, `Class.InputBinding.UIButton|UIButton`, or composite directions.
summary: |
Specifies a primary `Enum.KeyCode` that must be pressed for the binding to
activate.
description: |
Specifies a `Enum.KeyCode` that serves as a required modifier for the
binding. The `Class.InputBinding` will only trigger the parent
`Class.InputAction` if this input is pressed prior to
`Class.InputBinding.KeyCode|KeyCode`,
`Class.InputBinding.UIButton|UIButton`, or composite directions.
There is no ordering requirement between `Class.InputBinding.PrimaryModifier|PrimaryModifier` and
`Class.InputBinding.SecondaryModifier|SecondaryModifier`. If both properties are set, both modifiers
must be pressed to activate the binding, but the order in which they are pressed does not matter.
There is no ordering requirement between
`Class.InputBinding.PrimaryModifier|PrimaryModifier` and
`Class.InputBinding.SecondaryModifier|SecondaryModifier`. If both
properties are set, both modifiers must be pressed to activate the
binding, but the order in which they are pressed does not matter.
If set to `Enum.KeyCode.Unknown`, no primary modifier is required.
code_samples: []
@ -227,10 +234,10 @@ properties:
capabilities:
- Input
- name: InputBinding.ReleasedThreshold
summary: |-
summary: |
Numerical value below which to fire an `Class.InputAction` with a
`Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`.
description: |-
description: |
Numerical value below which to fire an `Class.InputAction` with a
`Class.InputAction.Type|Type` of `Enum.InputActionType|Bool`, for example
when a gamepad trigger such as `Enum.KeyCode.ButtonL2` falls below `0.5`
@ -254,18 +261,22 @@ properties:
capabilities:
- Input
- name: InputBinding.ResponseCurve
summary: Numerical value to configure scaling for more precise thumbstick aiming.
description: |-
A numerical value to control the sensitivity of gamepad thumbstick input by applying
a quadratic response curve. Commonly used for camera control to make small thumbstick inputs more
precise, while ramping up quickly to allow for large movements with higher magnitude input.
summary: |
Numerical value to configure scaling for more precise thumbstick aiming.
description: |
A numerical value to control the sensitivity of gamepad thumbstick input
by applying a quadratic response curve. Commonly used for camera control
to make small thumbstick inputs more precise, while ramping up quickly to
allow for large movements with higher magnitude input.
Ranges between `1` to `10`, with higher values providing a more intense curve.
Default is `1`, at which input is returned exactly as received.
Ranges between `1` to `10`, with higher values providing a more intense
curve. Default is `1`, at which input is returned exactly as received.
Only applicable when the parent action's `Class.InputAction.Type|Type` is
`Enum.InputActionType|Direction2D` and the `Class.InputBinding.KeyCode|KeyCode`
is `Enum.KeyCode.Thumbstick1|Thumbstick1` or `Enum.KeyCode.Thumbstick2|Thumbstick2`.
`Enum.InputActionType|Direction2D` and the
`Class.InputBinding.KeyCode|KeyCode` is
`Enum.KeyCode.Thumbstick1|Thumbstick1` or
`Enum.KeyCode.Thumbstick2|Thumbstick2`.
code_samples: []
type: float
tags: []
@ -281,10 +292,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Right
summary: |-
summary: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally
"right" inputs to the parent `Class.InputAction`.
description: |-
description: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally
"right" inputs to `Class.InputAction:GetState()|GetState()` and the
`Class.InputAction.StateChanged|StateChanged` event of the parent
@ -317,10 +328,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Scale
summary: |-
summary: |
Amount by which to linearly scale the values of a directional
`Class.InputAction`.
description: |-
description: |
Amount by which to linearly scale the values of an `Class.InputAction`
with `Class.InputAction.Type|Type` of `Enum.InputActionType|Direction1D`,
`Enum.InputActionType|Direction2D`, or `Enum.InputActionType|Direction3D`.
@ -339,15 +350,21 @@ properties:
capabilities:
- Input
- name: InputBinding.SecondaryModifier
summary: Specifies a secondary `Enum.KeyCode` that must be pressed for the binding to activate.
description: |-
Specifies a `Enum.KeyCode` that serves as a required modifier for the binding. The `Class.InputBinding`
will only trigger the parent `Class.InputAction` if this input is pressed prior to
`Class.InputBinding.KeyCode|KeyCode`, `Class.InputBinding.UIButton|UIButton`, or composite directions.
summary: |
Specifies a secondary `Enum.KeyCode` that must be pressed for the binding
to activate.
description: |
Specifies a `Enum.KeyCode` that serves as a required modifier for the
binding. The `Class.InputBinding` will only trigger the parent
`Class.InputAction` if this input is pressed prior to
`Class.InputBinding.KeyCode|KeyCode`,
`Class.InputBinding.UIButton|UIButton`, or composite directions.
There is no ordering requirement between `Class.InputBinding.PrimaryModifier|PrimaryModifier` and
`Class.InputBinding.SecondaryModifier|SecondaryModifier`. If both properties are set, both modifiers
must be pressed to activate the binding, but the order in which they are pressed does not matter.
There is no ordering requirement between
`Class.InputBinding.PrimaryModifier|PrimaryModifier` and
`Class.InputBinding.SecondaryModifier|SecondaryModifier`. If both
properties are set, both modifiers must be pressed to activate the
binding, but the order in which they are pressed does not matter.
If set to `Enum.KeyCode.Unknown`, no secondary modifier is required.
code_samples: []
@ -365,8 +382,10 @@ properties:
capabilities:
- Input
- name: InputBinding.UIButton
summary: Connects a `Class.GuiButton` to a boolean action.
description: '`Class.GuiButton` to connect to a boolean action.'
summary: |
Connects a `Class.GuiButton` to a boolean action.
description: |
`Class.GuiButton` to connect to a boolean action.
code_samples: []
type: GuiButton
tags: []
@ -382,10 +401,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Up
summary: |-
summary: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally "up"
inputs to the parent `Class.InputAction`.
description: |-
description: |
Specifies an alternate `Enum.KeyCode` for dispatching directionally "up"
inputs to `Class.InputAction:GetState()|GetState()` and the
`Class.InputAction.StateChanged|StateChanged` event of the parent
@ -422,10 +441,10 @@ properties:
capabilities:
- Input
- name: InputBinding.Vector2Scale
summary: |-
summary: |
Amount by which to linearly scale the values of a two-directional
`Class.InputAction`.
description: |-
description: |
Amount by which to linearly scale the values of an `Class.InputAction`
with `Class.InputAction.Type|Type` of `Enum.InputActionType|Direction2D`.
code_samples: []

132
.cursor/rules/roblox/en-us/reference/engine/classes/MaterialService.yaml
View file

@ -64,7 +64,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.BasaltName
summary: |
Specify `Class.MaterialVariant` name to override built-in Basalt.
@ -85,7 +86,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.BrickName
summary: |
Specify `Class.MaterialVariant` name to override built-in Brick.
@ -106,7 +108,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.CardboardName
summary: ''
description: ''
@ -123,7 +126,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.CarpetName
summary: ''
description: ''
@ -140,7 +144,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.CeramicTilesName
summary: ''
description: ''
@ -157,7 +162,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.ClayRoofTilesName
summary: ''
description: ''
@ -174,7 +180,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.CobblestoneName
summary: |
Specify `Class.MaterialVariant` name to override built-in Cobblestone.
@ -195,7 +202,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.ConcreteName
summary: |
Specify `Class.MaterialVariant` name to override built-in Concrete.
@ -216,7 +224,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.CorrodedMetalName
summary: |
Specify `Class.MaterialVariant` name to override built-in CorrodedMetal.
@ -237,7 +246,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.CrackedLavaName
summary: |
Specify `Class.MaterialVariant` name to override built-in CrackedLava.
@ -258,7 +268,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.DiamondPlateName
summary: |
Specify `Class.MaterialVariant` name to override built-in DiamondPlate.
@ -279,7 +290,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.FabricName
summary: |
Specify `Class.MaterialVariant` name to override built-in Fabric.
@ -300,7 +312,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.FoilName
summary: |
Specify `Class.MaterialVariant` name to override built-in Foil.
@ -321,7 +334,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.GlacierName
summary: |
Specify `Class.MaterialVariant` name to override built-in Glacier.
@ -342,7 +356,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.GraniteName
summary: |
Specify `Class.MaterialVariant` name to override built-in Granite.
@ -363,7 +378,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.GrassName
summary: |
Specify `Class.MaterialVariant` name to override built-in Grass.
@ -384,7 +400,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.GroundName
summary: |
Specify `Class.MaterialVariant` name to override built-in Ground.
@ -405,7 +422,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.IceName
summary: |
Specify `Class.MaterialVariant` name to override built-in Ice.
@ -426,7 +444,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.LeafyGrassName
summary: |
Specify `Class.MaterialVariant` name to override built-in LeafyGrass.
@ -447,7 +466,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.LeatherName
summary: ''
description: ''
@ -464,7 +484,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.LimestoneName
summary: |
Specify `Class.MaterialVariant` name to override built-in Limestone.
@ -485,7 +506,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.MarbleName
summary: |
Specify `Class.MaterialVariant` name to override built-in Marble.
@ -506,7 +528,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.MetalName
summary: |
Specify `Class.MaterialVariant` name to override built-in Metal.
@ -527,7 +550,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.MudName
summary: |
Specify `Class.MaterialVariant` name to override built-in Mud.
@ -548,7 +572,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.PavementName
summary: |
Specify `Class.MaterialVariant` name to override built-in Pavement.
@ -569,7 +594,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.PebbleName
summary: |
Specify `Class.MaterialVariant` name to override built-in Pebble.
@ -590,7 +616,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.PlasterName
summary: ''
description: ''
@ -607,7 +634,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.PlasticName
summary: |
Specify `Class.MaterialVariant` name to override built-in Plastic.
@ -628,7 +656,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.RockName
summary: |
Specify `Class.MaterialVariant` name to override built-in Rock.
@ -649,7 +678,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.RoofShinglesName
summary: ''
description: ''
@ -666,7 +696,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.RubberName
summary: ''
description: ''
@ -683,7 +714,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.SaltName
summary: |
Specify `Class.MaterialVariant` name to override built-in Salt.
@ -704,7 +736,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.SandName
summary: |
Specify `Class.MaterialVariant` name to override built-in Sand.
@ -725,7 +758,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.SandstoneName
summary: |
Specify `Class.MaterialVariant` name to override built-in Sandstone.
@ -746,7 +780,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.SlateName
summary: |
Specify `Class.MaterialVariant` name to override built-in Slate.
@ -767,7 +802,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.SmoothPlasticName
summary: |
Specify `Class.MaterialVariant` name to override built-in SmoothPlastic.
@ -788,7 +824,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.SnowName
summary: |
Specify `Class.MaterialVariant` name to override built-in Snow.
@ -809,7 +846,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.Use2022Materials
summary: |
Switch built-in material pack.
@ -829,7 +867,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- Material
- name: MaterialService.WoodName
summary: |
Specify `Class.MaterialVariant` name to override built-in Wood.
@ -850,7 +889,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialService.WoodPlanksName
summary: |
Specify `Class.MaterialVariant` name to override built-in WoodPlanks.
@ -871,7 +911,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
methods:
- name: MaterialService:GetBaseMaterialOverride
summary: |
@ -893,7 +934,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Material
- name: MaterialService:GetMaterialVariant
summary: |
Get the effective MaterialVariant reference given a name and Material.
@ -921,7 +963,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Material
- name: MaterialService:SetBaseMaterialOverride
summary: |
Set a `Class.MaterialVariant` name that overrides a built-in material.
@ -946,6 +989,7 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Material
events: []
callbacks: []

48
.cursor/rules/roblox/en-us/reference/engine/classes/MaterialVariant.yaml
View file

@ -56,7 +56,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.BaseMaterial
summary: |
Category Material this variant belongs to.
@ -74,7 +75,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.ColorMap
summary: |
Determines the color of the surface.
@ -93,7 +95,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.ColorMapContent
summary: |
Determines the color of the surface. Only supports asset URIs as textures.
@ -112,7 +115,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.CustomPhysicalProperties
summary: ''
description: ''
@ -128,7 +132,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.EmissiveMaskContent
summary: |
Determines the emissivity across the surface.
@ -153,7 +158,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.EmissiveStrength
summary: |
Determines the strength of emissive contribution.
@ -179,7 +185,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.EmissiveTint
summary: |
Determines the tinting color for emissive contribution.
@ -197,7 +204,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.MaterialPattern
summary: |
Determines texture tiling method.
@ -215,7 +223,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.MetalnessMap
summary: |
Determines which parts of the surface are metal and are non-metal.
@ -248,7 +257,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.MetalnessMapContent
summary: |
Determines which parts of the surface are metal and are non-metal. Only
@ -282,7 +292,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.NormalMap
summary: |
Modifies the lighting of the surface by adding bumps, dents, cracks, and
@ -334,7 +345,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.NormalMapContent
summary: |
Modifies the lighting of the surface by adding bumps, dents, cracks, and
@ -386,7 +398,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.RoughnessMap
summary: |
Determines the apparent roughness across the surface.
@ -411,7 +424,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.RoughnessMapContent
summary: |
Determines the apparent roughness across the surface. Only supports asset
@ -437,7 +451,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
- name: MaterialVariant.StudsPerTile
summary: |
Determines the scale of textures.
@ -456,7 +471,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Material
methods: []
events: []
callbacks: []

4
.cursor/rules/roblox/en-us/reference/engine/classes/NetworkReplicator.yaml
View file

@ -37,6 +37,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Network
- Players
events: []
callbacks: []

34
.cursor/rules/roblox/en-us/reference/engine/classes/NetworkSettings.yaml
View file

@ -39,7 +39,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- Network
- name: NetworkSettings.FreeMemoryMBytes
summary: |
Describes how much free memory is available, in MiBs.
@ -61,7 +62,8 @@ properties:
serialization:
can_load: false
can_save: false
capabilities: []
capabilities:
- Network
- name: NetworkSettings.HttpProxyEnabled
summary: ''
description: ''
@ -77,7 +79,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.HttpProxyURL
summary: ''
description: ''
@ -93,7 +96,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.IncomingReplicationLag
summary: |
Simulates additional network latency in the network receiving path.
@ -112,7 +116,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.PrintJoinSizeBreakdown
summary: |
Prints diagnostic information about data sent on connect.
@ -134,7 +139,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.PrintPhysicsErrors
summary: |
Whether debug messages will be printed to the output pertaining to physics
@ -172,7 +178,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.PrintStreamInstanceQuota
summary: |
Whether debug information is printed to the output regarding the
@ -221,7 +228,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.RandomizeJoinInstanceOrder
summary: |
Special facility to help catch bugs related to how your experience loads.
@ -242,7 +250,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.RenderStreamedRegions
summary: |
Whether regions of space that are being streamed to the client will be
@ -263,7 +272,8 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- name: NetworkSettings.ShowActiveAnimationAsset
summary: |
Whether a label will be shown above each player character's head, showing
@ -284,7 +294,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Network
- Animation
methods: []
events: []
callbacks: []

28
.cursor/rules/roblox/en-us/reference/engine/classes/PlayerScripts.yaml
View file

@ -45,7 +45,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- name: PlayerScripts:ClearComputerMovementModes
summary: |
Unregisters all ComputerMovementMode enums from the experience's settings
@ -62,7 +63,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Input
- Players
- name: PlayerScripts:ClearTouchCameraMovementModes
summary: |
Unregisters all TouchCameraMovementMode enums from the experience's
@ -79,7 +82,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- name: PlayerScripts:ClearTouchMovementModes
summary: |
Unregisters all TouchMovementMode enums from the experience's settings
@ -96,7 +100,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Input
- Players
- name: PlayerScripts:RegisterComputerCameraMovementMode
summary: |
Registers that a computer camera movement mode is available to be selected
@ -117,7 +123,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- name: PlayerScripts:RegisterComputerMovementMode
summary: |
Registers that a computer movement mode is available to be selected from
@ -138,7 +145,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Input
- Players
- name: PlayerScripts:RegisterTouchCameraMovementMode
summary: |
Registers that a touch camera movement mode is available to be selected
@ -159,7 +168,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Players
- name: PlayerScripts:RegisterTouchMovementMode
summary: |
Registers that a touch movement mode is available to be selected from the
@ -180,6 +190,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Input
- Players
events: []
callbacks: []

25
.cursor/rules/roblox/en-us/reference/engine/classes/ProximityPrompt.yaml
View file

@ -91,6 +91,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.AutoLocalize
summary: |
Whether the prompt's `Class.ProximityPrompt.ActionText` and
@ -116,6 +117,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.ClickablePrompt
summary: |
Whether the prompt can be activated by clicking/tapping on the prompt UI.
@ -137,6 +139,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.Enabled
summary: |
Whether or not this prompt should be shown.
@ -157,6 +160,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.Exclusivity
summary: |
Used to customize which prompts can be shown at the same time.
@ -177,6 +181,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.GamepadKeyCode
summary: |
The gamepad button the player should press to trigger the prompt.
@ -198,6 +203,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.HoldDuration
summary: |
The duration, in seconds, that the player must hold the button/key down to
@ -219,6 +225,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.KeyboardKeyCode
summary: |
The key the player should press to trigger the prompt.
@ -239,6 +246,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.MaxActivationDistance
summary: |
The maximum distance a Player's `Class.Player.Character|character` can be
@ -261,6 +269,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.MaxIndicatorDistance
summary: ''
description: ''
@ -278,6 +287,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.ObjectText
summary: |
An optional property that determines the object name text shown to the
@ -299,6 +309,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.RequiresLineOfSight
summary: |
Whether the prompt is hidden if the path between the player's
@ -326,6 +337,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.RootLocalizationTable
summary: |
A reference to a `Class.LocalizationTable` to be used to apply automated
@ -357,6 +369,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.Style
summary: |
The style of the prompt's UI.
@ -387,6 +400,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
- name: ProximityPrompt.UIOffset
summary: |
The pixel offset applied to the prompt's UI.
@ -406,6 +420,7 @@ properties:
can_save: true
capabilities:
- UI
- Input
methods:
- name: ProximityPrompt:InputHoldBegin
summary: |
@ -427,6 +442,7 @@ methods:
thread_safety: Unsafe
capabilities:
- UI
- Input
- name: ProximityPrompt:InputHoldEnd
summary: |
Fires a signal indicating that the user ended pressing the prompt GUI
@ -445,6 +461,7 @@ methods:
thread_safety: Unsafe
capabilities:
- UI
- Input
events:
- name: ProximityPrompt.IndicatorHidden
summary: ''
@ -456,6 +473,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.IndicatorShown
summary: ''
description: ''
@ -466,6 +484,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.PromptButtonHoldBegan
summary: |
Triggered when a player begins holding down the
@ -488,6 +507,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.PromptButtonHoldEnded
summary: |
Triggers when the player ends holding down the button on a prompt with a
@ -508,6 +528,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.PromptHidden
summary: |
Triggers when the `Class.ProximityPrompt|prompt` becomes hidden.
@ -521,6 +542,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.PromptShown
summary: |
Triggers when the `Class.ProximityPrompt|prompt` becomes visible.
@ -539,6 +561,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.Triggered
summary: |
Triggered when the prompt
@ -562,6 +585,7 @@ events:
security: None
capabilities:
- UI
- Input
- name: ProximityPrompt.TriggerEnded
summary: |
Triggers when `Class.ProximityPrompt.KeyboardKeyCode|key`/button is
@ -585,4 +609,5 @@ events:
security: None
capabilities:
- UI
- Input
callbacks: []

72
.cursor/rules/roblox/en-us/reference/engine/classes/TeleportService.yaml
View file

@ -7,12 +7,16 @@ type: class
memory_category: Instances
summary: |
Enables transporting `Class.Player|Players` between places and servers.
For more information on how to teleport players between servers, see
[Teleport between places](../../../projects/teleport.md).
description: |
**TeleportService** is responsible for transporting `Class.Player|Players`
between different places and servers.
For more information on how to teleport players between servers, see
[Teleporting Between Places](../../../projects/teleport.md).
[Teleport between places](../../../projects/teleport.md).
code_samples: []
inherits:
- Instance
@ -45,7 +49,8 @@ properties:
serialization:
can_load: true
can_save: false
capabilities: []
capabilities:
- Teleport
methods:
- name: TeleportService:GetArrivingTeleportGui
summary: |
@ -86,7 +91,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:GetLocalPlayerTeleportData
summary: |
Returns the _teleportData_ the `Class.Players.LocalPlayer` arrived into
@ -110,7 +117,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:GetPlayerPlaceInstanceAsync
summary: |
Returns the `Class.DataModel.PlaceId|PlaceId` and
@ -204,7 +212,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:GetTeleportSetting
summary: |
Retrieves a teleport setting saved using
@ -281,7 +290,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:PromptExperienceDetailsAsync
summary: |
Prompts a `Class.Player` with information about the specified experience.
@ -332,7 +342,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:ReserveServerAsync
summary: |
Returns an access code that can be used to teleport players to a reserved
@ -400,7 +411,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:ReserveServer
summary: |
Returns an access code that can be used to teleport players to a reserved
@ -428,7 +440,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:SetTeleportGui
summary: |
Sets the custom `Class.ScreenGui|teleport GUI` that will be shown to the
@ -484,7 +497,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:SetTeleportSetting
summary: |
Stores a value under a given key that persists across all teleportations
@ -571,7 +586,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Teleport
- name: TeleportService:Teleport
summary: |
Teleports a `Class.Player` to the place associated with the given
@ -616,7 +632,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:TeleportAsync
summary: |
The all-encompassing method to teleport a player or group of players from
@ -683,7 +701,7 @@ methods:
For more information on how to teleport players between servers and
receive user data from a teleport, see
[Teleporting Between Places](../../../projects/teleport.md#sending-user-data-along-with-teleports).
[Teleport between places](../../../projects/teleport.md#sending-user-data-along-with-teleports).
code_samples: []
parameters:
- name: placeId
@ -714,7 +732,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:TeleportPartyAsync
summary: |
Teleports a group of `Class.Player|Players` to the same server of the
@ -762,7 +782,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:TeleportToPlaceInstance
summary: |
Teleports a `Class.Player` to the server instance associated with the
@ -816,7 +838,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:TeleportToPrivateServer
summary: |
Teleport a group of `Class.Player|Players` to a reserved server created
@ -871,7 +895,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
- name: TeleportService:TeleportToSpawnByName
summary: |
A variant of `Class.TeleportService:Teleport()` that causes the
@ -921,7 +947,9 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- UI
- Teleport
events:
- name: TeleportService.LocalPlayerArrivedFromTeleport
summary: |
@ -996,7 +1024,8 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- Teleport
- name: TeleportService.TeleportInitFailed
summary: |
Fires when a teleport fails to start, leaving the player in their current
@ -1060,7 +1089,7 @@ events:
</table>
For more information on how to teleport players between servers, see
[Teleporting Between Places](../../../projects/teleport.md).
[Teleport between places](../../../projects/teleport.md).
code_samples: []
parameters:
- name: player
@ -1092,5 +1121,6 @@ events:
tags: []
deprecation_message: ''
security: None
capabilities: []
capabilities:
- Teleport
callbacks: []

2
.cursor/rules/roblox/en-us/reference/engine/classes/TestService.yaml
View file

@ -748,7 +748,7 @@ methods:
summary: ''
- name: source
type: Instance
default:
default: nil
summary: ''
returns:
- type: ()

17
.cursor/rules/roblox/en-us/reference/engine/classes/VoiceChatService.yaml
View file

@ -46,7 +46,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Chat
- name: VoiceChatService.EnableDefaultVoice
summary: |
Controls whether each voice-eligible player can be heard as though they
@ -74,7 +76,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Chat
- name: VoiceChatService.UseAudioApi
summary: |
Controls whether voice chat is represented and controlled by
@ -113,7 +117,9 @@ properties:
serialization:
can_load: true
can_save: true
capabilities: []
capabilities:
- Audio
- Chat
methods:
- name: VoiceChatService:GetChatGroupsAsync
summary: |
@ -181,6 +187,7 @@ methods:
security: None
thread_safety: Unsafe
capabilities:
- Audio
- Chat
- name: VoiceChatService:IsVoiceEnabledForUserIdAsync
summary: |
@ -221,6 +228,8 @@ methods:
deprecation_message: ''
security: None
thread_safety: Unsafe
capabilities: []
capabilities:
- Audio
- Chat
events: []
callbacks: []

9
.cursor/rules/roblox/en-us/reference/engine/classes/Wire.yaml
View file

@ -57,10 +57,11 @@ properties:
`Class.Wire.SourceInstance|SourceInstance`,
`Class.Wire.TargetInstance|TargetInstance`,
`Class.Wire.SourceName|SourceName`, and `Class.Wire.TargetName|TargetName`
properties are all assigned, the connection is valid, and the connection
does not result in a cyclic processing graph. Cyclic processing graphs are
invalid since they can result in infinite computation; attempting to
create one will log an error.
properties are all assigned, the corresponding
`Class.Wire.SourceName|SourceName` and `Class.Wire.TargetName|TargetName`
pins exist on `Class.Wire.SourceInstance|SourceInstance` and
`Class.Wire.TargetInstance|TargetInstance` respectively, and the
connection does not result in a cyclic processing graph.
code_samples: []
type: boolean
tags: