Workspace

extends RootInstance

Class fields

FieldXML typeValue
NamestringWorkspace
ExplorerOrderstring1
ExplorerImageIndexstring19

Properties

11
AllowThirdPartySales
bool
FieldXML typeValue
NamestringAllowThirdPartySales
CurrentCamera
Object
FieldXML typeValue
NamestringCurrentCamera
DistributedGameTime
double
FieldXML typeValue
NamestringDistributedGameTime
ExpSolverEnabled_Replicate
bool
FieldXML typeValue
NamestringExpSolverEnabled_Replicate
FallenPartsDestroyHeight
float
FieldXML typeValue
NamestringFallenPartsDestroyHeight
summarystringSets the height at which falling characters and parts are destroyed. This property is not scriptable and can only be set in Studio
FilteringEnabled
bool
FieldXML typeValue
NamestringFilteringEnabled
PGSPhysicsSolverEnabled
bool
FieldXML typeValue
NamestringPGSPhysicsSolverEnabled
summarystringBoolean used to enable the experimental physics solver
PhysicalPropertiesMode
PhysicalPropertiesMode
FieldXML typeValue
NamestringPhysicalPropertiesMode
SignalBehavior
SignalBehavior
FieldXML typeValue
NamestringSignalBehavior
summarystringDetermines whether event handlers are resumed immediately when an event fires or deferred until a later resumption point.
StreamingEnabled
bool
FieldXML typeValue
NamestringStreamingEnabled
Terrain
Object
FieldXML typeValue
NamestringTerrain

Functions

22
BreakJoints
(objects: Objects) → void
FieldXML typeValue
NamestringBreakJoints
ExperimentalSolverIsEnabled
() → bool
FieldXML typeValue
NamestringExperimentalSolverIsEnabled
FindPartOnRay
(ray: Ray, ignoreDescendentsInstance: Instance = …, terrainCellsAreCubes: bool = …, ignoreWater: bool = …) → Tuple
FieldXML typeValue
NamestringFindPartOnRay
summarystringReturn type is (BasePart, Vector3) if the ray hits. If it misses it will return (nil, PointAtEndOfRay)
FindPartOnRayWithIgnoreList
(ray: Ray, ignoreDescendentsTable: Objects, terrainCellsAreCubes: bool = …, ignoreWater: bool = …) → Tuple
FieldXML typeValue
NamestringFindPartOnRayWithIgnoreList
summarystringReturn type is (BasePart, Vector3) if the ray hits. If it misses it will return (nil, PointAtEndOfRay)
FindPartsInRegion3
(region: Region3, ignoreDescendentsInstance: Instance = …, maxParts: int = …) → Objects
FieldXML typeValue
NamestringFindPartsInRegion3
summarystringReturns parts in the area defined by the Region3, up to specified maxCount or 100, whichever is less
FindPartsInRegion3WithIgnoreList
(region: Region3, ignoreDescendentsTable: Objects, maxParts: int = …) → Objects
FieldXML typeValue
NamestringFindPartsInRegion3WithIgnoreList
summarystringReturns parts in the area defined by the Region3, up to specified maxCount or 100, whichever is less
GetNumAwakeParts
() → int
FieldXML typeValue
NamestringGetNumAwakeParts
GetPhysicsAnalyzerBreakOnIssue
() → bool
FieldXML typeValue
NamestringGetPhysicsAnalyzerBreakOnIssue
GetPhysicsAnalyzerIssue
(index: int) → Objects
FieldXML typeValue
NamestringGetPhysicsAnalyzerIssue
GetPhysicsThrottling
() → int
FieldXML typeValue
NamestringGetPhysicsThrottling
GetRealPhysicsFPS
() → double
FieldXML typeValue
NamestringGetRealPhysicsFPS
IsRegion3Empty
(region: Region3, ignoreDescendentsInstance: Instance = …) → bool
FieldXML typeValue
NamestringIsRegion3Empty
IsRegion3EmptyWithIgnoreList
(region: Region3, ignoreDescendentsTable: Objects) → bool
FieldXML typeValue
NamestringIsRegion3EmptyWithIgnoreList
JoinToOutsiders
(objects: Objects, jointType: JointCreationMode) → void
FieldXML typeValue
NamestringJoinToOutsiders
MakeJoints
(objects: Objects) → void
FieldXML typeValue
NamestringMakeJoints
PGSIsEnabled
() → bool
FieldXML typeValue
NamestringPGSIsEnabled
SetPhysicsAnalyzerBreakOnIssue
(enable: bool) → void
FieldXML typeValue
NamestringSetPhysicsAnalyzerBreakOnIssue
SetPhysicsThrottleEnabled
(value: bool) → void
FieldXML typeValue
NamestringSetPhysicsThrottleEnabled
UnjoinFromOutsiders
(objects: Objects) → void
FieldXML typeValue
NamestringUnjoinFromOutsiders
ZoomToExtents
() → void
FieldXML typeValue
NamestringZoomToExtents
findPartOnRay
(ray: Ray, ignoreDescendentsInstance: Instance = …, terrainCellsAreCubes: bool = …, ignoreWater: bool = …) → Tuple
FieldXML typeValue
NamestringfindPartOnRay
findPartsInRegion3
(region: Region3, ignoreDescendentsInstance: Instance = …, maxParts: int = …) → Objects
FieldXML typeValue
NamestringfindPartsInRegion3

Events

1
PhysicsAnalyzerIssuesFound
(count: int) → void
FieldXML typeValue
NamestringPhysicsAnalyzerIssuesFound