ProtectedconstructorCreates a new Volume3 from a list of vertices and optional ObjectTracker(s).
The list of Vector3(s) that make up the volume.
Optionaltrackers: ObjectTracker[]The optional list of ObjectTracker(s) that make up the volume.
The created Volume3.
Static ReadonlyModelEnum used to represent how a given Volume3 should query against any given Model.
ReadonlyAll: 2Any Volume3 using ModelQueryMode.All will only consider any given Model entered / inside if ALL of its descendant BasePart(s) meets the current PartQueryMode requirements.
ReadonlyAny: 1Any Volume3 using ModelQueryMode.Any will consider any given Model entered / inside if any descendant BasePart meets the current PartQueryMode requirements.
ReadonlyPrimary: 3Any Volume3 using ModelQueryMode.Primary will only consider any given Model entered / inside if its PrimaryPart meets the current PartQueryMode requirements.
StaticObjectStatic ReadonlyObjectEnum used to represent what points an ObjectTracker should gather from its target Object.
ReadonlyBox: 2Any ObjectTracker using ObjectTrackerMode.Box will track and update using all 8 corner points of the tracked object or its bounds, taking into account rotation,
and acting as a cloud of vertices for any containing Volume3(s)
ReadonlyPoint: 1Any ObjectTracker using ObjectTrackerMode.Point will only track and update using the center point of the tracked object or its bounds, effectively ignoring rotation,
and acting as a single vertex for any containing Volume3(s)
Static ReadonlyObjectEnum used to represent how a Volume3 should recalculate its bounds when an ObjectTracker it contains fires its LiveUpdate.
ReadonlyHigh: 2Any Volume3 containing an ObjectTracker using ObjectTrackerPrecision.High should recalculate its true bounds upon receiving a LiveUpdate.
This is useful for when accuracy is more important than performance, or when tracked objects in the same Volume3 move or rotate independently of one another.
e.g. ObjectTracker(s) are tracking objects that move each based on their own assembly or system.
ReadonlyLow: 1Any Volume3 containing an ObjectTracker using ObjectTrackerPrecision.Low should only update positions, and never recalculate its true bounds.
This is useful for large numbers of trackers where performance is more important than accuracy, or when all tracked objects are guaranteed to move at the same time in the same way.
e.g. all ObjectTracker(s) are tracking objects connected to the same assembly.
Static ReadonlyPartEnum used to represent how a given Volume3 should query against any given BasePart.
ReadonlyBox: 2Any Volume3 using PartQueryMode.Box will consider any given BasePart entered / inside if the volume overlaps or contains it in any way.
ReadonlyPoint: 1Any Volume3 using PartQueryMode.Point will only consider any given BasePart entered / inside if the volume contains the center point.
Checks if the given Model or BasePart is inside this Volume3 ( warns and returns false if not aware ).
The Model or BasePart to check.
Whether the object is inside and aware.
Begins listening for updates to this Volume3, attaching a query to the RunService.PostSimulation event.
Clears all awareness of objects within this Volume3.
Destroys this Volume3, disconnecting all connections and clearing all data.
Destroys this Volume3, disconnecting all connections and clearing all data, including destroying all contained ObjectTracker(s).
Gets an array of all Model or BasePart instances that this Volume3 is aware of and are inside it.
An array of objects that are inside and aware.
Gets the current ModelQueryMode defining how this Volume3 queries against any given Model.
The current ModelQueryMode.
Gets the current PartQueryMode defining how this Volume3 queries against any given BasePart.
The current PartQueryMode.
Checks if this Volume3 is aware of the given Model or BasePart.
The Model or BasePart to check awareness for.
Whether this Volume3 is aware of the given object.
Checks if the given Model or BasePart is inside this Volume3.
The Model or BasePart to check.
Whether the object is inside.
Sets the current ModelQueryMode defining how this Volume3 queries against any given Model.
The ModelQueryMode to set.
Sets the current PartQueryMode defining how this Volume3 queries against any given BasePart.
The PartQueryMode to set.
Sets the visibility, creation and destruction of the debug parts for this Volume3.
Whether the debug parts should exist.
Stops listening for updates to this Volume3, disconnecting from the RunService.PostSimulation event.
Attempts to forget the given Model or BasePart, removing awareness.
The Model or BasePart to forget.
Whether the forget was successful.
Attempts to make this Volume3 aware of the given Model or BasePart.
The Model or BasePart to become aware of.
Whether to automatically forget the object when it is destroyed. Defaults to true.
Whether the awareness was successfully added.
StaticFromCreates a new Volume3 from an axis-aligned box defined by a position and Vector3 size.
The Vector3 defining the center position of the box.
The Vector3 defining the size of the box.
The created Volume3.
StaticFromCreates a new Volume3 from a box defined by a CFrame and Vector3 size.
The CFrame defining the center and rotation of the box.
The Vector3 defining the size of the box.
The created Volume3.
StaticFromCreates a new Volume3 from a list of ObjectTracker(s).
The list of ObjectTracker(s) that make up the volume.
The created Volume3.
StaticFromCreates a new Volume3 from a plane defined by 4 corner vertices and a depth to extrude.
The list of 4 or more Vector3(s) that make up the corners of the plane.
The depth to extrude the plane along the Z axis.
The created Volume3.
StaticFromCreates a new Volume3 from a plane defined by 4 corner vertices and a height to extrude.
The list of 4 or more Vector3(s) that make up the corners of the plane.
The height to extrude the plane upwards along the Y axis.
The created Volume3.
StaticFromCreates a new Volume3 from a plane defined by 4 corner vertices and a width to extrude.
The list of 4 or more Vector3(s) that make up the corners of the plane.
The width to extrude the plane along the X axis.
The created Volume3.
StaticFromCreates a new Volume3 from an existing Region3.
The Region3 to create the volume from.
The created Volume3.
Volume3.FromBox for a more generalized and efficient method of creating a box-shaped Volume3.Volume3.FromAABB for creating an axis-aligned box-shaped Volume3.StaticFromCreates a new Volume3 from a list of vertices.
The list of Vector3(s) that make up the volume.
The created Volume3.
ReadonlyAnyThe Signal that is fired upon any BasePart or Model ( that this Volume3 is aware of ) entering the volume.
ReadonlyAnyThe Signal that is fired upon any BasePart or Model ( that this Volume3 is aware of ) leaving the volume.
ReadonlyModelThe Signal that is fired upon any Model ( that this Volume3 is aware of ) entering the volume.
ReadonlyModelThe Signal that is fired upon any Model ( that this Volume3 is aware of ) leaving the volume.
ReadonlyPartThe Signal that is fired upon any BasePart ( that this Volume3 is aware of ) entering the volume.
ReadonlyPartThe Signal that is fired upon any BasePart ( that this Volume3 is aware of ) leaving the volume.
The
Volume3class is used to represent a 3D volume in space defined by a set of vertices or tracked objects, allowing for efficient querying ofModel(s) andBasePart(s) entering and leaving the volume.See
ObjectTracker