Reference API Roblox

Engine API

Website

Related

Reference API Roblox

API updates in 2025
Show all changes.

Click a date to expand or collapse changes.

2025-02-07 15:34 (v0.659.2.6590479) version-0e04f568006340ec
- No changes
2025-02-07 14:28 (v0.659.1.6590477) version-f8ba67a5589843db
- No changes
2025-02-04 10:12 (v0.659.0.6590474) version-c35b65070a714765Release notes
- Add AnnotationsService.EditAnnotation
- Add AnnotationsService.AnnotationEdited
- Add AudioAnalyzer.WindowSize
- Add AudioEcho.Reset
- Add AudioListener.Reset
- Add AudioPitchShifter.WindowSize
- Change CanSave of AudioPlayer.Asset from false to true
- Change Tags of AudioPlayer.Asset from [Hidden, NotScriptable] to []
- Change CanSave of AudioPlayer.AssetId from true to false
- Change PreferredDescriptor of AudioPlayer.AssetId from to Asset
- Change Tags of AudioPlayer.AssetId from [] to [Hidden, NotReplicated, Deprecated]
- Add AudioReverb.Reset
- Add GlobalSettings.GetFFlagOverrides
- Add GlobalSettings.GetFFlags
- Add GlobalSettings.SetFFlagOverrides
- Add PartOperation.SolidMeshData
- Add SoundService.CharacterSoundsUseNewApi
- Add Stats.ResetHarmonyMemoryTarget
- Add Stats.SetHarmonyMemoryTarget
- Add Studio.AutoResumeSyncOnPlaceOpen
- Change Tags of TextChatService.HasSeenDeprecationDialog from [] to [Hidden, NotReplicated]
- Add UGCValidationService.CreateEditableImageFromBinaryStringRobloxOnly
- Add UGCValidationService.CreateEditableMeshFromBinaryStringRobloxOnly
- Add UGCValidationService.GetEditableImageData
- Add UGCValidationService.GetMeshDataBinaryString
- Add UGCValidationService.RegisterAlternateMesh
- Add VoiceChatService.leaveVoice
- Add ProductPurchaseChannel.AdReward
- Add ProductPurchaseChannel.CommerceProduct
2025-01-30 09:18 (v0.658.1.6580464) version-16563d9619244148
- No changes
2025-01-28 11:07 (v0.658.0.6580461) version-35ab2f0d73f349eeRelease notes
- Add AuroraService.FixedRateTick
- Add BugReporterService
  - Add IsAvailable
  - Add BugReportRequested
- Change Parameters of ChangeHistoryService.OnRecordingFinished from (name: string, displayName: string?, identifier: string?, operationn: FinishRecordingOperation, finalOptions: Dictionary?) to (name: string, displayName: string?, identifier: string?, operation: FinishRecordingOperation, finalOptions: Dictionary?)
- Add Chat.IsAutoMigrated
- Add CreatorStoreService.PerformCreatorStorePurchase
- Add PublishService.CreateAssetOrAssetVersionAndPollAssetWithTelemetryAsyncWithAddParamErrorJson
- Remove StartPageService.getTutorialVersionForUser
- Change Tags of StarterPlayer.GameSettingsAvatar from [Hidden, NotReplicated] to [Hidden]
- Remove TutorialService.GetStudioWidgetFromLabel
- Remove TutorialService.GetTutorialIDToLaunch
- Add ProductPurchaseChannel
  - Add ExperienceDetailsPage
  - Add InExperience
2025-01-21 11:22 (v0.657.0.6570603) version-96b5c87ce0ce4dffRelease notes
- Remove AdService.GetAdAvailability
- Add AdService.GetAdAvailabilityNowAsync
- Add AdService.HandleWhyThisAdClicked
- Add AdService.OnDemandVideoCompleteFromUI
- Remove AdService.AdAvailabilityChanged
- Add AdService.onDemandVideoPlayInUI
- Add AppLifecycleObserverService.TriggerOnLuaAppInteractive
- Change Tags of Chat.TimeoutChatAttempt from [Hidden] to []
- Change Tags of FeatureRestrictionManager.TimeoutChatAttempt from [Hidden] to []
- Add Instance.GetStyledPropertyChangedSignal
- Add Instance.StyledPropertiesChanged
- Add LiveSyncService
  - Add HasSyncedInstances
  - Add GetSyncState
  - Add SyncStatusChanged
- Add TextChatMessage.Verified
- Add TextChatService.HasSeenDeprecationDialog
- Remove TextChatService.ClientToServerMessageReplicateSignal
- Add TextChatService.ClientToServerMessageReplicateSignalV3
- Change Tags of UserGameSettings from [NotCreatable, UserSettings] to [NotCreatable, UserSettings, NotReplicated]
- Change Default of UserGameSettings.AllTutorialsDisabled from to
- Change Default of UserGameSettings.CameraMode from to
- Change Default of UserGameSettings.CameraYInverted from to
- Change Default of UserGameSettings.ChatTranslationEnabled from to
- Change Default of UserGameSettings.ChatTranslationFTUXShown from to
- Change Default of UserGameSettings.ChatTranslationLocale from to
- Change Default of UserGameSettings.ChatTranslationToggleEnabled from to
- Change Default of UserGameSettings.ChatVisible from to
- Change Default of UserGameSettings.CompletedTutorials from to
- Change Default of UserGameSettings.ComputerCameraMovementChanged from to
- Change Default of UserGameSettings.ComputerCameraMovementMode from to
- Change Default of UserGameSettings.ComputerMovementChanged from to
- Change Default of UserGameSettings.ComputerMovementMode from to
- Change Default of UserGameSettings.ControlMode from to
- Change Default of UserGameSettings.DefaultCameraID from to
- Change Default of UserGameSettings.FramerateCap from to
- Change Default of UserGameSettings.Fullscreen from to
- Change Default of UserGameSettings.GamepadCameraSensitivity from to
- Change Default of UserGameSettings.GraphicsOptimizationMode from to
- Change Default of UserGameSettings.GraphicsQualityLevel from to
- Change Default of UserGameSettings.HapticStrength from to
- Change Default of UserGameSettings.HasEverUsedVR from to
- Change Default of UserGameSettings.IsUsingCameraYInverted from to
- Change Default of UserGameSettings.IsUsingGamepadCameraSensitivity from to
- Change Default of UserGameSettings.MasterVolume from to
- Change Default of UserGameSettings.MasterVolumeStudio from to
- Change Default of UserGameSettings.MaxQualityEnabled from to
- Change Default of UserGameSettings.MicroProfilerWebServerEnabled from to
- Change Default of UserGameSettings.MicroProfilerWebServerIP from to
- Change Default of UserGameSettings.MicroProfilerWebServerPort from to
- Change Default of UserGameSettings.MouseSensitivity from to
- Change Default of UserGameSettings.MouseSensitivityFirstPerson from to
- Change Default of UserGameSettings.MouseSensitivityThirdPerson from to
- Change Default of UserGameSettings.OnScreenProfilerEnabled from to
- Change Default of UserGameSettings.OnboardingsCompleted from to
- Change Default of UserGameSettings.PartyVoiceVolume from to
- Change Default of UserGameSettings.PerformanceStatsVisible from to
- Change Default of UserGameSettings.PlayerHeight from to
- Change Default of UserGameSettings.PreferredTextSize from to
- Change Default of UserGameSettings.PreferredTransparency from to
- Change Default of UserGameSettings.QualityResetLevel from to
- Change Default of UserGameSettings.RCCProfilerRecordFrameRate from to
- Change Default of UserGameSettings.RCCProfilerRecordTimeFrame from to
- Change Default of UserGameSettings.ReducedMotion from to
- Change Default of UserGameSettings.RotationType from to
- Change Default of UserGameSettings.SavedQualityLevel from to
- Change Default of UserGameSettings.StartMaximized from to
- Change Default of UserGameSettings.StartScreenPosition from to
- Change Default of UserGameSettings.StartScreenSize from to
- Change Default of UserGameSettings.TouchCameraMovementChanged from to
- Change Default of UserGameSettings.TouchCameraMovementMode from to
- Change Default of UserGameSettings.TouchMovementChanged from to
- Change Default of UserGameSettings.TouchMovementMode from to
- Change Default of UserGameSettings.UiNavigationKeyBindEnabled from to
- Change Default of UserGameSettings.UsedCoreGuiIsVisibleToggle from to
- Change Default of UserGameSettings.UsedCustomGuiIsVisibleToggle from to
- Change Default of UserGameSettings.UsedHideHudShortcut from to
- Change Default of UserGameSettings.VRComfortSetting from to
- Change Default of UserGameSettings.VREnabled from to
- Change Default of UserGameSettings.VRRotationIntensity from to
- Change Default of UserGameSettings.VRSafetyBubbleMode from to
- Change Default of UserGameSettings.VRSmoothRotationEnabled from to
- Change Default of UserGameSettings.VRSmoothRotationEnabledCustomOption from to
- Change Default of UserGameSettings.VRThirdPersonFollowCamEnabled from to
- Change Default of UserGameSettings.VRThirdPersonFollowCamEnabledCustomOption from to
- Change Default of UserGameSettings.VignetteEnabled from to
- Change Default of UserGameSettings.VignetteEnabledCustomOption from to
- Change Default of UserGameSettings.gaID from to
- Add AdAvailabilityResult
  - Add DeviceIneligible
  - Add ExperienceIneligible
  - Add InternalError
  - Add IsAvailable
  - Add NoFill
  - Add PlayerIneligible
  - Add PublisherIneligible
- Add BenefitType
  - Add AvatarAsset
  - Add AvatarBundle
  - Add DeveloperProduct
- Add ShowAdResult.AdAlreadyShowing
- Add ShowAdResult.AdNotReady
- Remove ShowAdResult.ExperienceIneligible
- Add ShowAdResult.InternalError
- Remove ShowAdResult.NotShown
- Remove ShowAdResult.PlayerIneligible
- Change Value of ShowAdResult.ShowCompleted from 3 to 1
- Change Index of ShowAdResult.ShowCompleted from 3 to 0
- Change Value of ShowAdResult.ShowInterrupted from 4 to 5
2025-01-14 11:00 (v0.656.0.6560679) version-343512800f264d5bRelease notes
- Add Decal.TextureContent
- Add Humanoid.ComputeOriginalSizeForPart
- Change Tags of PackageLink.HasNewVersion from [Hidden, ReadOnly, NotReplicated] to [Hidden, NotReplicated]
- Add PackageUIService.ConvertToMockPackage
- Add StartPageService.shouldShowMacOSDeprecationWarning
- Add StartPageService.shouldShowWinOSDeprecationWarning
- Add Studio.AutocompleteAcceptanceBehavior
- Add Studio.TypeColor
- Add CompletionAcceptanceBehavior
  - Add Insert
  - Add InsertOnEnterReplaceOnTab
  - Add Replace
  - Add ReplaceOnEnterInsertOnTab
- Change Value of StudioScriptEditorColorCategories.AICOOverlayButtonBackground from 42 to 43
- Change Index of StudioScriptEditorColorCategories.AICOOverlayButtonBackground from 42 to 43
- Change Index of StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundHover from 43 to 44
- Change Value of StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundHover from 43 to 44
- Change Value of StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundPressed from 44 to 45
- Change Index of StudioScriptEditorColorCategories.AICOOverlayButtonBackgroundPressed from 44 to 45
- Change Value of StudioScriptEditorColorCategories.AICOOverlayText from 41 to 42
- Change Index of StudioScriptEditorColorCategories.AICOOverlayText from 41 to 42
- Change Index of StudioScriptEditorColorCategories.DocViewCodeBackground from 40 to 41
- Change Value of StudioScriptEditorColorCategories.DocViewCodeBackground from 40 to 41
- Change Index of StudioScriptEditorColorCategories.IndentationRuler from 45 to 46
- Change Value of StudioScriptEditorColorCategories.IndentationRuler from 45 to 46
- Change Value of StudioScriptEditorColorCategories.MenuBackground from 35 to 36
- Change Index of StudioScriptEditorColorCategories.MenuBackground from 35 to 36
- Change Index of StudioScriptEditorColorCategories.MenuBorder from 39 to 40
- Change Value of StudioScriptEditorColorCategories.MenuBorder from 39 to 40
- Change Value of StudioScriptEditorColorCategories.MenuPrimaryText from 32 to 33
- Change Index of StudioScriptEditorColorCategories.MenuPrimaryText from 32 to 33
- Change Value of StudioScriptEditorColorCategories.MenuScrollbarBackground from 37 to 38
- Change Index of StudioScriptEditorColorCategories.MenuScrollbarBackground from 37 to 38
- Change Index of StudioScriptEditorColorCategories.MenuScrollbarHandle from 38 to 39
- Change Value of StudioScriptEditorColorCategories.MenuScrollbarHandle from 38 to 39
- Change Value of StudioScriptEditorColorCategories.MenuSecondaryText from 33 to 34
- Change Index of StudioScriptEditorColorCategories.MenuSecondaryText from 33 to 34
- Change Value of StudioScriptEditorColorCategories.MenuSelectedBackground from 36 to 37
- Change Index of StudioScriptEditorColorCategories.MenuSelectedBackground from 36 to 37
- Change Value of StudioScriptEditorColorCategories.MenuSelectedText from 34 to 35
- Change Index of StudioScriptEditorColorCategories.MenuSelectedText from 34 to 35
- Add StudioScriptEditorColorCategories.Type
2025-01-07 14:20 (v0.655.0.6551095) version-d7ec89f14d9e47ceRelease notes
- Add AdService.CreateAdRewardFromDevProductId
- Add AdService.GetAdAvailability
- Add AdService.ShowRewardedVideoAdAsync
- Add AdService.AdAvailabilityChanged
- Add AdService.ShowReportAdPopup
- Remove AdService.ShowStaticEudsaDisclosure
- Add AdService.rewardedVideoAdPlayServerToClient
- Add AdService.rewardedVideoAdResultClientToServer
- Add AudioCompressor.Editor
- Add AudioLimiter.Editor
- Add AuroraService.GetDesyncedInstances
- Add AuroraService.GetRemoteWorldStepId
- Add AuroraService.GetWorldStepId
- Add AuroraService.StepPhysics
- Add AuroraService.Desynced
- Add AuroraService.Synced
- Change ReadSecurity of HapticEffect.Position from RobloxScriptSecurity to None
- Change WriteSecurity of HapticEffect.Position from RobloxScriptSecurity to None
- Change ReadSecurity of HapticEffect.Radius from RobloxScriptSecurity to None
- Change WriteSecurity of HapticEffect.Radius from RobloxScriptSecurity to None
- Remove HapticEffect.SetKeys
- Add HapticEffect.SetWaveformKeys
- Change Default of RenderingTest.RenderingTestFrameCount from 120 to 20
- Change Default of RenderingTest.Timeout from 10 to 30
- Add SoundService.OpenAudioCompressorEditorSignal
- Add Stats.GetMemoryCategoryNames
- Add Stats.GetMemoryUsageMbAllCategories
- Remove StreamingService.DEPRECATED_RegisterCommand
- Remove StreamingService.DEPRECATED_RegisterSequentialCommand
- Remove StudioWidgetsService.AttachPluginGui
- Add TextBox.ShouldEmitUpAndDownArrowEvents
- Change ThreadSafety of TweenService.SmoothDamp from Unsafe to Safe
- Change Parameters of WebViewService.MutateWindow from (url: string, title: string?, isVisible: bool?, searchType: string?, transitionAnimation: string?) to (url: string, title: string?, isVisible: bool?, searchType: string?, transitionAnimation: string?, showDomainAsTitle: bool?)
- Change Parameters of WebViewService.OpenWindow from (url: string, title: string?, isVisible: bool?, searchType: string?, transitionAnimation: string?) to (url: string, title: string?, isVisible: bool?, searchType: string?, transitionAnimation: string?, showDomainAsTitle: bool?)
- Add Workspace.FallHeightEnabled
- Add AdFormat
  - Add RewardedVideo
- Add HapticEffectType.Custom
- Change Index of HapticEffectType.GameplayCollision from 4 to 5
- Change Index of HapticEffectType.GameplayExplosion from 3 to 4
- Change Index of HapticEffectType.UIClick from 1 to 2
- Change Index of HapticEffectType.UIHover from 0 to 1
- Change Index of HapticEffectType.UINotification from 2 to 3
- Add PromptCreateAvatarResult.TokenInvalid
- Add ShowAdResult
  - Add ExperienceIneligible
  - Add NotShown
  - Add PlayerIneligible
  - Add ShowCompleted
  - Add ShowInterrupted

Settings