@rbxts/types 1.0.931 → 1.0.933

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.
package/include/lua.d.ts CHANGED
@@ -567,7 +567,7 @@ declare namespace math {
567
567
 
568
568
  /** Returns the hyperbolic tangent of x. */
569
569
  function tanh(n: number): number;
570
-
570
+
571
571
  /** Returns true if x is NaN, otherwise false */
572
572
  function isnan(x: number): boolean;
573
573
 
@@ -1971,13 +1971,27 @@ interface OverlapParams {
1971
1971
  * @deprecated
1972
1972
  */
1973
1973
  readonly _nominal_OverlapParams: unique symbol;
1974
+ /**
1975
+ * An optional array of instances whose descendants will be excluded from the query. This property can be used simultaneously with [IncludeInstances](https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#IncludeInstances) to allow for mixed filtering, for example including a large folder but excluding specific child instances. If an instance matches both an exclude and include filter, exclusions take priority over inclusions.
1976
+ */
1977
+ ExcludeInstances: Array<Instance> | undefined;
1978
+ /**
1979
+ * An optional array of instances whose descendants will be included in the query. This property can be used simultaneously with [ExcludeInstances](https://create.roblox.com/docs/reference/engine/datatypes/OverlapParams#ExcludeInstances) to allow for mixed filtering. If an instance matches both an exclude and include filter, exclusions take priority over inclusions.
1980
+ *
1981
+ * Setting `IncludeInstances` to `nil` versus an empty array (`{}`) has opposite effects. `IncludeInstances = nil` is the most permissive filter (includes everything), whereas `IncludeInstances = {}` is the most restrictive filter (includes nothing).
1982
+ */
1983
+ IncludeInstances: Array<Instance> | undefined;
1974
1984
  /**
1975
1985
  * An array of objects whose descendants will be used in filtering.
1986
+ *
1987
+ * @deprecated Use `ExcludeInstances` and `IncludeInstances`
1976
1988
  */
1977
1989
  FilterDescendantsInstances: Array<Instance>;
1978
1990
  /**
1979
1991
  * `RaycastFilterType.Include` or `RaycastFilterType.Exclude`. Determines how the `FilterDescendantInstances` is
1980
1992
  * used. `Exclude` will skip the `FilterDescendantInstances`, and `Include` will exclusively include them.
1993
+ *
1994
+ * @deprecated Use `ExcludeInstances` and `IncludeInstances`
1981
1995
  */
1982
1996
  FilterType: Enum.RaycastFilterType;
1983
1997
  /**
@@ -2000,6 +2014,8 @@ interface OverlapParams {
2000
2014
  /**
2001
2015
  * For efficiency and simplicity, this method is the preferred way to add instances to the filter.
2002
2016
  * It has the additional advantage that it allows FilterDescendantsInstances to be updated from a parallel context.
2017
+ *
2018
+ * @deprecated Use `ExcludeInstances` and `IncludeInstances`
2003
2019
  */
2004
2020
  AddToFilter(this: OverlapParams, instances: Instance | Array<Instance>): void;
2005
2021
  }
@@ -2175,7 +2191,20 @@ interface RaycastParams {
2175
2191
  * @deprecated
2176
2192
  */
2177
2193
  readonly _nominal_RaycastParams: unique symbol;
2178
- /** An array of objects whose descendants will be used in filtering raycasting candidates. */
2194
+ /**
2195
+ * An optional array of instances whose descendants will be excluded from the query. This property can be used simultaneously with [IncludeInstances](https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#IncludeInstances) to allow for mixed filtering, for example including a large folder but excluding specific child instances. If an instance matches both an exclude and include filter, exclusions take priority over inclusions.
2196
+ */
2197
+ ExcludeInstances: Array<Instance> | undefined;
2198
+ /**
2199
+ * An optional array of instances whose descendants will be included in the query. This property can be used simultaneously with [ExcludeInstances](https://create.roblox.com/docs/reference/engine/datatypes/RaycastParams#ExcludeInstances) to allow for mixed filtering. If an instance matches both an exclude and include filter, exclusions take priority over inclusions.
2200
+ *
2201
+ * Setting `IncludeInstances` to `nil` versus an empty array (`{}`) has opposite effects. `IncludeInstances = nil` is the most permissive filter (includes everything), whereas `IncludeInstances = {}` is the most restrictive filter (includes nothing).
2202
+ */
2203
+ IncludeInstances: Array<Instance> | undefined;
2204
+ /** An array of objects whose descendants will be used in filtering raycasting candidates.
2205
+ *
2206
+ * @deprecated Use `ExcludeInstances` and `IncludeInstances`
2207
+ */
2179
2208
  FilterDescendantsInstances: Array<Instance>;
2180
2209
  /**
2181
2210
  * Determines how the `FilterDescendantsInstances` list will be used, depending on the
@@ -2185,6 +2214,8 @@ interface RaycastParams {
2185
2214
  * which are descendants of objects in the filter list will be considered in the raycast operation.
2186
2215
  * - `Enum.RaycastFilterType.Exclude` — Every [BasePart](https://developer.roblox.com/api-reference/class/BasePart)
2187
2216
  * in the game will be considered except those that are descendants of objects in the filter list.
2217
+ *
2218
+ * @deprecated Use `ExcludeInstances` and `IncludeInstances`
2188
2219
  */
2189
2220
  FilterType: Enum.RaycastFilterType;
2190
2221
  /**
@@ -2211,6 +2242,8 @@ interface RaycastParams {
2211
2242
  /**
2212
2243
  * For efficiency and simplicity, this method is the preferred way to add instances to the filter.
2213
2244
  * It has the additional advantage that it allows FilterDescendantsInstances to be updated from a parallel context.
2245
+ *
2246
+ * @deprecated Use `ExcludeInstances` and `IncludeInstances`
2214
2247
  */
2215
2248
  AddToFilter(this: RaycastParams, instances: Instance | Array<Instance>): void;
2216
2249
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/types",
3
- "version": "1.0.931",
3
+ "version": "1.0.933",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },