@rbxts/types 1.0.914 → 1.0.915

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2929,7 +2929,7 @@ interface AdService extends Instance {
2929
2929
  *
2930
2930
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AdService#RegisterDisclosureButton)
2931
2931
  */
2932
- RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, immersiveBrandedAdId: string): void;
2932
+ RegisterDisclosureButton(this: AdService, disclosureButton: GuiButton, adIntegrationPlacementId: string): void;
2933
2933
  /**
2934
2934
  * **Deprecated:** `ShowVideoAd` has been decommissioned and is no longer operational.
2935
2935
  *
@@ -6694,9 +6694,14 @@ interface AudioPlayer extends Instance {
6694
6694
  */
6695
6695
  Volume: number;
6696
6696
  /**
6697
+ * Attempts to cancel a pre-planned future `Play` or `Stop` command.
6698
+ *
6697
6699
  * - **ThreadSafety**: Unsafe
6698
6700
  *
6699
6701
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/AudioPlayer#Cancel)
6702
+ * @param this Used to play audio assets.
6703
+ * @param actionId The unique-ID of a pre-planned `Play` or `Stop` command.
6704
+ * @returns Whether the cancellation was successful. Returns false if the action has already occurred, or otherwise does not exist.
6700
6705
  */
6701
6706
  Cancel(this: AudioPlayer, actionId?: number): boolean;
6702
6707
  /**
@@ -19102,8 +19107,6 @@ interface GuiButton extends GuiObject {
19102
19107
  */
19103
19108
  readonly MouseButton2Up: RBXScriptSignal<(x: number, y: number) => void>;
19104
19109
  /**
19105
- * Fires when a right-click is detected on desktop, long press detected on mobile, or triangle / Y activated in UI navigation mode on console. This function is not available yet.
19106
- *
19107
19110
  * - **ThreadSafety**: Unsafe
19108
19111
  *
19109
19112
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/GuiButton#SecondaryActivated)
@@ -27866,6 +27869,13 @@ interface LogService extends Instance {
27866
27869
  * @param this A service that allows you to read outputted text.
27867
27870
  */
27868
27871
  ClearOutput(this: LogService): void;
27872
+ /**
27873
+ * - **ThreadSafety**: Unsafe
27874
+ * - **Tags**: CustomLuaState
27875
+ *
27876
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Error)
27877
+ */
27878
+ Error(this: LogService, message: string, context?: object): void;
27869
27879
  /**
27870
27880
  * Returns a table of tables, each with the message string, message type, and timestamp of a message that the client displays in the output window.
27871
27881
  *
@@ -27875,6 +27885,34 @@ interface LogService extends Instance {
27875
27885
  * @param this A service that allows you to read outputted text.
27876
27886
  */
27877
27887
  GetLogHistory(this: LogService): Array<LogInfo>;
27888
+ /**
27889
+ * - **ThreadSafety**: Unsafe
27890
+ * - **Tags**: CustomLuaState
27891
+ *
27892
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Info)
27893
+ */
27894
+ Info(this: LogService, message: string, context?: object): void;
27895
+ /**
27896
+ * - **ThreadSafety**: Unsafe
27897
+ * - **Tags**: CustomLuaState
27898
+ *
27899
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Log)
27900
+ */
27901
+ Log(this: LogService, messageType: CastsToEnum<Enum.MessageType>, message: string, context?: object): void;
27902
+ /**
27903
+ * - **ThreadSafety**: Unsafe
27904
+ * - **Tags**: CustomLuaState
27905
+ *
27906
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Output)
27907
+ */
27908
+ Output(this: LogService, message: string, context?: object): void;
27909
+ /**
27910
+ * - **ThreadSafety**: Unsafe
27911
+ * - **Tags**: CustomLuaState
27912
+ *
27913
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#Warn)
27914
+ */
27915
+ Warn(this: LogService, message: string, context?: object): void;
27878
27916
  /**
27879
27917
  * Fires when the client outputs text.
27880
27918
  *
@@ -27882,7 +27920,7 @@ interface LogService extends Instance {
27882
27920
  *
27883
27921
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/LogService#MessageOut)
27884
27922
  */
27885
- readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType) => void>;
27923
+ readonly MessageOut: RBXScriptSignal<(message: string, messageType: Enum.MessageType, context: object) => void>;
27886
27924
  }
27887
27925
  /**
27888
27926
  * The base class for all objects which contain Luau code.
@@ -41011,9 +41049,13 @@ interface SoundService extends Instance {
41011
41049
  BasePart
41012
41050
  ]>;
41013
41051
  /**
41052
+ * Returns the number of seconds since the audio engine began mixing.
41053
+ *
41014
41054
  * - **ThreadSafety**: Unsafe
41015
41055
  *
41016
41056
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SoundService#GetMixerTime)
41057
+ * @param this A service that determines various aspects of how the audio engine works. Most of its properties affect how `Sounds` play in the experience.
41058
+ * @returns The number of seconds since the audio engine began mixing. This value is stable, sample-accurate, and monotonically-increasing – intended to be used for scheduling audible changes at precise times.
41017
41059
  */
41018
41060
  GetMixerTime(this: SoundService): number;
41019
41061
  /**
@@ -42395,6 +42437,12 @@ interface SurfaceAppearance extends Instance {
42395
42437
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#NormalMapContent)
42396
42438
  */
42397
42439
  get NormalMapContent(): Content;
42440
+ /**
42441
+ * - **ThreadSafety**: ReadSafe
42442
+ *
42443
+ * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/SurfaceAppearance#ResampleMode)
42444
+ */
42445
+ ResampleMode: Enum.ResamplerMode;
42398
42446
  /**
42399
42447
  * - **ThreadSafety**: ReadSafe
42400
42448
  * - **Tags**: Hidden
@@ -42859,7 +42907,7 @@ interface TeleportService extends Instance {
42859
42907
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/classes/TeleportService#PromptExperienceDetailsAsync)
42860
42908
  * @param this Enables transporting `Players` between places and servers. For more information on how to teleport players between servers, see [Teleport between places](../../../projects/teleport.md).
42861
42909
  * @param player The `Player` to be presented the prompt.
42862
- * @param universeId `DataModel.UniverseId` of the experience to be presented to the `Player`
42910
+ * @param universeId `DataModel.UniverseId` of the experience to be presented to the `Player`.
42863
42911
  * @returns `PromptExperienceDetailsResult`
42864
42912
  */
42865
42913
  PromptExperienceDetailsAsync(this: TeleportService, player: Player, universeId: number): Enum.PromptExperienceDetailsResult;
@@ -22913,7 +22913,7 @@ declare namespace Enum {
22913
22913
  */
22914
22914
  export namespace ModelStreamingBehavior {
22915
22915
  /**
22916
- * Engine determines best behavior. Currently equivalent to **Legacy**.
22916
+ * Default behavior (subject to change).
22917
22917
  *
22918
22918
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ModelStreamingBehavior#Default)
22919
22919
  */
@@ -22935,7 +22935,7 @@ declare namespace Enum {
22935
22935
  }
22936
22936
  export const Legacy: Legacy;
22937
22937
  /**
22938
- * Models are never sent during player join. Models that are "non-spatial" (containing no `BasePart` descendants) are sent soon after join, but before the `Workspace.PersistentLoaded` event fires. Models that are "spatial" (containing `BasePart` descendants) are sent when any `BasePart` descendant needs to be streamed to a client, and may stream out when all `BasePart` descendants are eligible to stream out.
22938
+ * Models are never sent during player join. See [model streaming controls](../../../workspace/streaming/index.md#model-streaming-controls) for detailed behavioral notes.
22939
22939
  *
22940
22940
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ModelStreamingBehavior#Improved)
22941
22941
  */
@@ -22957,7 +22957,7 @@ declare namespace Enum {
22957
22957
  */
22958
22958
  export namespace ModelStreamingMode {
22959
22959
  /**
22960
- * Engine determines best behavior. Currently equivalent to **Nonatomic**.
22960
+ * Default behavior (subject to change).
22961
22961
  *
22962
22962
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#Default)
22963
22963
  */
@@ -22990,7 +22990,7 @@ declare namespace Enum {
22990
22990
  }
22991
22991
  export const Persistent: Persistent;
22992
22992
  /**
22993
- * Behaves as a persistent model for players that have been added using `Model:AddPersistentPlayer()`. For other players, behavior is the same as **Atomic**. You can revert a model from player persistence via `Model:RemovePersistentPlayer()`.
22993
+ * Behaves as a persistent model for players that have been added using `Model:AddPersistentPlayer()`. For other players, behavior is the same as `Atomic`. You can revert a model from player persistence via `Model:RemovePersistentPlayer()`.
22994
22994
  *
22995
22995
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/ModelStreamingMode#PersistentPerPlayer)
22996
22996
  */
@@ -28381,10 +28381,6 @@ declare namespace Enum {
28381
28381
  EnumType: typeof globalThis.Enum.RigLabel;
28382
28382
  }
28383
28383
  export const Spine: Spine;
28384
- /**
28385
- * @deprecated renamed to Spine
28386
- */
28387
- export const Pelvis: Spine;
28388
28384
  /**
28389
28385
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RigLabel#Chest)
28390
28386
  */
@@ -28430,10 +28426,6 @@ declare namespace Enum {
28430
28426
  EnumType: typeof globalThis.Enum.RigLabel;
28431
28427
  }
28432
28428
  export const LeftToeBase: LeftToeBase;
28433
- /**
28434
- * @deprecated renamed to LeftToeBase
28435
- */
28436
- export const LeftToes: LeftToeBase;
28437
28429
  /**
28438
28430
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RigLabel#RightToeBase)
28439
28431
  */
@@ -28443,10 +28435,6 @@ declare namespace Enum {
28443
28435
  EnumType: typeof globalThis.Enum.RigLabel;
28444
28436
  }
28445
28437
  export const RightToeBase: RightToeBase;
28446
- /**
28447
- * @deprecated renamed to RightToeBase
28448
- */
28449
- export const RightToes: RightToeBase;
28450
28438
  /**
28451
28439
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/RigLabel#Thumb1)
28452
28440
  */
@@ -31270,13 +31258,13 @@ declare namespace Enum {
31270
31258
  }
31271
31259
  export type StepFrequency = StepFrequency.Hz60 | StepFrequency.Hz30 | StepFrequency.Hz15 | StepFrequency.Hz10 | StepFrequency.Hz5 | StepFrequency.Hz1;
31272
31260
  /**
31273
- * Determines how content is streamed away from Players.
31261
+ * Determines how content is streamed out from `Player` clients.
31274
31262
  *
31275
31263
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior)
31276
31264
  */
31277
31265
  export namespace StreamOutBehavior {
31278
31266
  /**
31279
- * Currently equivalent to LowMemory. This will eventually change to Opportunistic.
31267
+ * Default behavior (subject to change).
31280
31268
  *
31281
31269
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior#Default)
31282
31270
  */
@@ -31298,7 +31286,7 @@ declare namespace Enum {
31298
31286
  }
31299
31287
  export const LowMemory: LowMemory;
31300
31288
  /**
31301
- * Stream out content that is significantly outside of the current StreamingRadius.
31289
+ * Stream out content that is significantly outside of the current `Workspace.StreamingTargetRadius`.
31302
31290
  *
31303
31291
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StreamOutBehavior#Opportunistic)
31304
31292
  */
@@ -31320,7 +31308,7 @@ declare namespace Enum {
31320
31308
  */
31321
31309
  export namespace StreamingIntegrityMode {
31322
31310
  /**
31323
- * Default behavior (currently equivalent to **Disabled**).
31311
+ * Default behavior (subject to change).
31324
31312
  *
31325
31313
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StreamingIntegrityMode#Default)
31326
31314
  */
@@ -31369,7 +31357,7 @@ declare namespace Enum {
31369
31357
  }
31370
31358
  export type StreamingIntegrityMode = StreamingIntegrityMode.Default | StreamingIntegrityMode.Disabled | StreamingIntegrityMode.MinimumRadiusPause | StreamingIntegrityMode.PauseOutsideLoadedArea;
31371
31359
  /**
31372
- * Determines how a Players client should handle not having enough content streamed in to continue playing properly.
31360
+ * Determines how a client should handle not having enough content streamed in to continue playing properly.
31373
31361
  *
31374
31362
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StreamingPauseMode)
31375
31363
  */
@@ -31377,7 +31365,7 @@ declare namespace Enum {
31377
31365
  /**
31378
31366
  * **Deprecated:**
31379
31367
  *
31380
- * Default behavior (currently no change to gameplay).
31368
+ * Default behavior (subject to change).
31381
31369
  *
31382
31370
  * [Creator Hub](https://create.roblox.com/docs/reference/engine/enums/StreamingPauseMode#Default)
31383
31371
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.914",
3
+ "version": "1.0.915",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },