Module roblox::instance [−][src]
Expand description
This module contains types for all Roblox Instance classes.
Examples
All Instance types follow a similar API to that of Roblox. Fields and methods are snake_case rather than PascalCase, however. For example, here’s some Luau that deals with an Instance:
And the equivalent Rust:
Structs
The ABTestService Instance Class
The Accessory Instance Class
The Accoutrement Instance Class
The Actor Instance Class
The AdService Instance Class
The AdvancedDragger Instance Class
The AlignOrientation Instance Class
The AlignPosition Instance Class
The AnalysticsSettings Instance Class
The AnalyticsService Instance Class
The AngularVelocity Instance Class
The Animation Instance Class
The AnimationController Instance Class
The AnimationRigData Instance Class
The AnimationTrack Instance Class
The Animator Instance Class
The AppStorageService Instance Class
The AppUpdateService Instance Class
The ArcHandles Instance Class
The AssetCounterService Instance Class
The AssetDeliveryProxy Instance Class
The AssetImportService Instance Class
The AssetManagerService Instance Class
The AssetService Instance Class
The Atmosphere Instance Class
The Attachment Instance Class
The AvatarEditorService Instance Class
The AvatarImportService Instance Class
The Backpack Instance Class
The BackpackItem Instance Class
The BadgeService Instance Class
The BallSocketConstraint Instance Class
The BasePart Instance Class
The BasePlayerGui Instance Class
The BaseScript Instance Class
The BaseWrap Instance Class
The Beam Instance Class
The BevelMesh Instance Class
The BillboardGui Instance Class
The BinaryStringValue Instance Class
The BindableEvent Instance Class
The BindableFunction Instance Class
The BlockMesh Instance Class
The BloomEffect Instance Class
The BlurEffect Instance Class
The BodyAngularVelocity Instance Class
The BodyColors Instance Class
The BodyForce Instance Class
The BodyGyro Instance Class
The BodyMover Instance Class
The BodyPosition Instance Class
The BodyThrust Instance Class
The BodyVelocity Instance Class
The Bone Instance Class
The BoolValue Instance Class
The BoxHandleAdornment Instance Class
The Breakpoint Instance Class
The BrickColorValue Instance Class
The BrowserService Instance Class
The BulkImportService Instance Class
The CFrameValue Instance Class
The CSGDictionaryService Instance Class
The CacheableContentProvider Instance Class
The CalloutService Instance Class
The Camera Instance Class
The CanvasGroup Instance Class
The CatalogPages Instance Class
The ChangeHistoryService Instance Class
The ChannelSelectorSoundEffect Instance Class
The CharacterAppearance Instance Class
The CharacterMesh Instance Class
The Chat Instance Class
The ChorusSoundEffect Instance Class
The ClickDetector Instance Class
The ClientReplicator Instance Class
The Clothing Instance Class
The Clouds Instance Class
The ClusterPacketCache Instance Class
The CollectionService Instance Class
The Color3Value Instance Class
The ColorCorrectionEffect Instance Class
The CommandInstance Instance Class
The CommandService Instance Class
The CompressorSoundEffect Instance Class
The ConeHandleAdornment Instance Class
The Configuration Instance Class
The Constraint Instance Class
The ContentProvider Instance Class
The ContextActionService Instance Class
The Controller Instance Class
The ControllerService Instance Class
The CookiesService Instance Class
The CoreGui Instance Class
The CorePackages Instance Class
The CoreScript Instance Class
The CoreScriptSyncService Instance Class
The CornerWedgePart Instance Class
The CustomDspSoundEffect Instance Class
The CustomEvent Instance Class
The CustomEventReceiver Instance Class
The CylinderHandleAdornment Instance Class
The CylinderMesh Instance Class
The CylindricalConstraint Instance Class
The DataModel Instance Class
The DataModelMesh Instance Class
The DataModelSession Instance Class
The DataStore Instance Class
The DataStoreIncrementOptions Instance Class
The DataStoreInfo Instance Class
The DataStoreKey Instance Class
The DataStoreKeyInfo Instance Class
The DataStoreKeyPages Instance Class
The DataStoreListingPages Instance Class
The DataStoreObjectVersionInfo Instance Class
The DataStoreOptions Instance Class
The DataStorePages Instance Class
The DataStoreService Instance Class
The DataStoreSetOptions Instance Class
The DataStoreVersionPages Instance Class
The Debris Instance Class
The DebugSettings Instance Class
The DebuggerBreakpoint Instance Class
The DebuggerConnection Instance Class
The DebuggerConnectionManager Instance Class
The DebuggerManager Instance Class
The DebuggerWatch Instance Class
The Decal Instance Class
The DepthOfFieldEffect Instance Class
The Dialog Instance Class
The DialogChoice Instance Class
The DistortionSoundEffect Instance Class
The DockWidgetPluginGui Instance Class
The DoubleConstrainedValue Instance Class
The DraftsService Instance Class
The Dragger Instance Class
The DraggerService Instance Class
The DynamicRotate Instance Class
The EchoSoundEffect Instance Class
The EmotesPages Instance Class
The EqualizerSoundEffect Instance Class
The EventIngestService Instance Class
The Explosion Instance Class
The FaceControls Instance Class
The FaceInstance Instance Class
The Feature Instance Class
The File Instance Class
The FileMesh Instance Class
The Fire Instance Class
The Flag Instance Class
The FlagStand Instance Class
The FlagStandService Instance Class
The FlangeSoundEffect Instance Class
The FloorWire Instance Class
The FlyweightService Instance Class
The Folder Instance Class
The ForceField Instance Class
The FormFactorPart Instance Class
The Frame Instance Class
The FriendPages Instance Class
The FriendService Instance Class
The FunctionalTest Instance Class
The GamePassService Instance Class
The GameSettings Instance Class
The GamepadService Instance Class
The GenericSettings Instance Class
The Geometry Instance Class
The GlobalDataStore Instance Class
The GlobalSettings Instance Class
The Glue Instance Class
The GoogleAnalyticsConfiguration Instance Class
The GroupService Instance Class
The GuiBase Instance Class
The GuiBase2d Instance Class
The GuiBase3d Instance Class
The GuiButton Instance Class
The GuiLabel Instance Class
The GuiMain Instance Class
The GuiObject Instance Class
The GuiService Instance Class
The GuidRegistryService Instance Class
The HandleAdornment Instance Class
The Handles Instance Class
The HandlesBase Instance Class
The HapticService Instance Class
The Hat Instance Class
The HeightmapImporterService Instance Class
The HingeConstraint Instance Class
The Hint Instance Class
The Hole Instance Class
The Hopper Instance Class
The HopperBin Instance Class
The HttpRbxApiService Instance Class
The HttpRequest Instance Class
The HttpService Instance Class
The Humanoid Instance Class
The HumanoidController Instance Class
The HumanoidDescription Instance Class
The ILegacyStudioBridge Instance Class
The IXPService Instance Class
The ImageButton Instance Class
The ImageHandleAdornment Instance Class
The ImageLabel Instance Class
The ImporterBaseSettings Instance Class
The ImporterGroupSettings Instance Class
The ImporterJointSettings Instance Class
The ImporterMeshSettings Instance Class
The ImporterRootSettings Instance Class
The ImporterTextureSettings Instance Class
The IncrementalPatchBuilder Instance Class
The InputObject Instance Class
The InsertService Instance Class
The InstanceAdornment Instance Class
The IntConstrainedValue Instance Class
The IntValue Instance Class
The InternalContainer Instance Class
The InventoryPages Instance Class
The JointInstance Instance Class
The JointsService Instance Class
The KeyboardService Instance Class
The Keyframe Instance Class
The KeyframeMarker Instance Class
The KeyframeSequence Instance Class
The KeyframeSequenceProvider Instance Class
The LanguageService Instance Class
The LayerCollector Instance Class
The LegacyStudioBridge Instance Class
The Light Instance Class
The Lighting Instance Class
The LineForce Instance Class
The LineHandleAdornment Instance Class
The LinearVelocity Instance Class
The LocalScript Instance Class
The LocalStorageService Instance Class
The LocalizationService Instance Class
The LocalizationTable Instance Class
The LogService Instance Class
The LoginService Instance Class
The LuaSettings Instance Class
The LuaSourceContainer Instance Class
The LuaWebService Instance Class
The ManualGlue Instance Class
The ManualSurfaceJointInstance Instance Class
The ManualWeld Instance Class
The MarketplaceService Instance Class
The MaterialService Instance Class
The MaterialVariant Instance Class
The MemStorageConnection Instance Class
The MemStorageService Instance Class
The MemoryStoreQueue Instance Class
The MemoryStoreService Instance Class
The MemoryStoreSortedMap Instance Class
The MeshContentProvider Instance Class
The MeshPart Instance Class
The Message Instance Class
The MessageBusConnection Instance Class
The MessageBusService Instance Class
The MessagingService Instance Class
The Model Instance Class
The ModuleScript Instance Class
The Motor Instance Class
The Motor6D Instance Class
The MotorFeature Instance Class
The Mouse Instance Class
The MouseService Instance Class
The MultipleDocumentInterfaceInstance Instance Class
The NegateOperation Instance Class
The NetworkClient Instance Class
The NetworkMarker Instance Class
The NetworkPeer Instance Class
The NetworkReplicator Instance Class
The NetworkServer Instance Class
The NetworkSettings Instance Class
The NoCollisionConstraint Instance Class
The NonReplicatedCSGDictionaryService Instance Class
The NotificationService Instance Class
The NumberPose Instance Class
The NumberValue Instance Class
The ObjectValue Instance Class
The OrderedDataStore Instance Class
The OutfitPages Instance Class
The PVAdornment Instance Class
The PVInstance Instance Class
The PackageLink Instance Class
The PackageService Instance Class
The Pages Instance Class
The Pants Instance Class
The ParabolaAdornment Instance Class
The Part Instance Class
The PartAdornment Instance Class
The PartOperation Instance Class
The PartOperationAsset Instance Class
The ParticleEmitter Instance Class
The Path Instance Class
The PathfindingModifier Instance Class
The PathfindingService Instance Class
The PausedState Instance Class
The PausedStateBreakpoint Instance Class
The PausedStateException Instance Class
The PermissionsService Instance Class
The PhysicsService Instance Class
The PhysicsSettings Instance Class
The PitchShiftSoundEffect Instance Class
The Platform Instance Class
The Player Instance Class
The PlayerEmulatorService Instance Class
The PlayerGui Instance Class
The PlayerMouse Instance Class
The PlayerScripts Instance Class
The Players Instance Class
The Plugin Instance Class
The PluginAction Instance Class
The PluginDebugService Instance Class
The PluginDragEvent Instance Class
The PluginGui Instance Class
The PluginGuiService Instance Class
The PluginManager Instance Class
The PluginManagerInterface Instance Class
The PluginMenu Instance Class
The PluginMouse Instance Class
The PluginPolicyService Instance Class
The PluginToolbar Instance Class
The PluginToolbarButton Instance Class
The PointLight Instance Class
The PointsService Instance Class
The PolicyService Instance Class
The Pose Instance Class
The PoseBase Instance Class
The PostEffect Instance Class
The PrismaticConstraint Instance Class
The ProximityPrompt Instance Class
The ProximityPromptService Instance Class
The PublishService Instance Class
The QWidgetPluginGui Instance Class
The RayValue Instance Class
The RbxAnalyticsService Instance Class
The ReflectionMetadata Instance Class
The ReflectionMetadataCallbacks Instance Class
The ReflectionMetadataClass Instance Class
The ReflectionMetadataClasses Instance Class
The ReflectionMetadataEnum Instance Class
The ReflectionMetadataEnumItem Instance Class
The ReflectionMetadataEnums Instance Class
The ReflectionMetadataEvents Instance Class
The ReflectionMetadataFunctions Instance Class
The ReflectionMetadataItem Instance Class
The ReflectionMetadataMember Instance Class
The ReflectionMetadataProperties Instance Class
The ReflectionMetadataYieldFunctions Instance Class
The RemoteDebuggerServer Instance Class
The RemoteEvent Instance Class
The RemoteFunction Instance Class
The RenderSettings Instance Class
The RenderingTest Instance Class
The ReplicatedFirst Instance Class
The ReplicatedScriptService Instance Class
The ReplicatedStorage Instance Class
The ReverbSoundEffect Instance Class
The RobloxPluginGuiService Instance Class
The RobloxReplicatedStorage Instance Class
The RocketPropulsion Instance Class
The RodConstraint Instance Class
The RopeConstraint Instance Class
The Rotate Instance Class
The RotateP Instance Class
The RotateV Instance Class
The RunService Instance Class
The RunningAverageItemDouble Instance Class
The RunningAverageItemInt Instance Class
The RunningAverageTimeIntervalItem Instance Class
The RuntimeScriptService Instance Class
The ScreenGui Instance Class
The Script Instance Class
The ScriptContext Instance Class
The ScriptDebugger Instance Class
The ScriptRef Instance Class
The ScriptRefId Instance Class
The ScriptRefPath Instance Class
The ScriptService Instance Class
The ScrollingFrame Instance Class
The Seat Instance Class
The Selection Instance Class
The SelectionBox Instance Class
The SelectionLasso Instance Class
The SelectionPartLasso Instance Class
The SelectionPointLasso Instance Class
The SelectionSphere Instance Class
The ServerReplicator Instance Class
The ServerScriptService Instance Class
The ServerStorage Instance Class
The ServiceProvider Instance Class
The SessionService Instance Class
The Shirt Instance Class
The ShirtGraphic Instance Class
The SkateboardController Instance Class
The SkateboardPlatform Instance Class
The Skin Instance Class
The Sky Instance Class
The SlidingBallConstraint Instance Class
The Smoke Instance Class
The Snap Instance Class
The SocialService Instance Class
The SolidModelContentProvider Instance Class
The Sound Instance Class
The SoundEffect Instance Class
The SoundGroup Instance Class
The SoundService Instance Class
The Sparkles Instance Class
The SpawnLocation Instance Class
The SpawnerService Instance Class
The Speaker Instance Class
The SpecialMesh Instance Class
The SphereHandleAdornment Instance Class
The SpotLight Instance Class
The SpringConstraint Instance Class
The StandalonePluginScripts Instance Class
The StandardPages Instance Class
The StarterCharacterScripts Instance Class
The StarterGear Instance Class
The StarterGui Instance Class
The StarterPack Instance Class
The StarterPlayer Instance Class
The StarterPlayerScripts Instance Class
The Stats Instance Class
The StatsItem Instance Class
The Status Instance Class
The StopWatchReporter Instance Class
The StringValue Instance Class
The Studio Instance Class
The StudioData Instance Class
The StudioDeviceEmulatorService Instance Class
The StudioService Instance Class
The StudioTheme Instance Class
The SunRaysEffect Instance Class
The SurfaceAppearance Instance Class
The SurfaceGui Instance Class
The SurfaceLight Instance Class
The SurfaceSelection Instance Class
The TaskScheduler Instance Class
The Team Instance Class
The Teams Instance Class
The TeleportAsyncResult Instance Class
The TeleportOptions Instance Class
The TeleportService Instance Class
The Terrain Instance Class
The TerrainRegion Instance Class
The TestService Instance Class
The TextBox Instance Class
The TextButton Instance Class
The TextFilterResult Instance Class
The TextLabel Instance Class
The TextService Instance Class
The Texture Instance Class
The ThirdPartyUserService Instance Class
The ThreadState Instance Class
The TimerService Instance Class
The ToastNotificationService Instance Class
The Tool Instance Class
The Torque Instance Class
The TorsionSpringConstraint Instance Class
The TotalCountTimeIntervalItem Instance Class
The TouchInputService Instance Class
The TouchTransmitter Instance Class
The TracerService Instance Class
The Trail Instance Class
The Translator Instance Class
The TremoloSoundEffect Instance Class
The TriangleMeshPart Instance Class
The TrussPart Instance Class
The Tween Instance Class
The TweenBase Instance Class
The TweenService Instance Class
The UGCValidationService Instance Class
The UIAspectRatioConstraint Instance Class
The UIBase Instance Class
The UIComponent Instance Class
The UIConstraint Instance Class
The UICorner Instance Class
The UIGradient Instance Class
The UIGridLayout Instance Class
The UIGridStyleLayout Instance Class
The UILayout Instance Class
The UIListLayout Instance Class
The UIPadding Instance Class
The UIPageLayout Instance Class
The UIScale Instance Class
The UISizeConstraint Instance Class
The UIStroke Instance Class
The UITableLayout Instance Class
The UITextSizeConstraint Instance Class
The UnionOperation Instance Class
The UniversalConstraint Instance Class
The UnvalidatedAssetService Instance Class
The UserGameSettings Instance Class
The UserInputService Instance Class
The UserService Instance Class
The UserSettings Instance Class
The UserStorageService Instance Class
The VRService Instance Class
The ValueBase Instance Class
The Vector3Value Instance Class
The VectorForce Instance Class
The VehicleController Instance Class
The VehicleSeat Instance Class
The VelocityMotor Instance Class
The VersionControlService Instance Class
The VideoFrame Instance Class
The ViewportFrame Instance Class
The VirtualInputManager Instance Class
The VirtualUser Instance Class
The Visit Instance Class
The VoiceChatService Instance Class
The VoiceSource Instance Class
The WedgePart Instance Class
The Weld Instance Class
The WeldConstraint Instance Class
The Workspace Instance Class
The WorldModel Instance Class
The WorldRoot Instance Class
The WrapLayer Instance Class
The WrapTarget Instance Class
Enums
The base Instance class.