Skip to content

Instance

Light supports validated types for (almost) every Instance.

Instances are generally Any Datatypes which represent a Roblox Instance Classname. Using these datatypes while sending unreliably can cause consistent packet dropping issues if the packet is too large.

You can access each one with datatypes.instances.<Name>, or any Instance with datatypes.instances.Instance

Tips

Use Enums

It is recommended to Use An Identifier Enum instead of instances.* whenever possible to avoid performance implications and validation overhead of instance datatypes.

Instance Replication

Keep in mind instances may not exist yet on the client when sent by light, unless you wait for them explicitly.

Supported Classes

Roblox Type Supported?
Instance ✅
AccessoryDescription ✅
Accoutrement ✅
Accessory ✅
Hat ✅
ActivityHistoryEventService ✅
AdPortal ✅
AdService ✅
AdvancedDragger ✅
Animation ✅
AnimationClip ✅
CurveAnimation ✅
KeyframeSequence ✅
AnimationController ✅
AnimationFromVideoCreatorService ✅
AnimationRigData ✅
AnimationTrack ✅
Animator ✅
Annotation ✅
WorkspaceAnnotation ✅
AnnotationsService ✅
AssetService ✅
Atmosphere ✅
Attachment ✅
Bone ✅
AudioAnalyzer ✅
AudioChannelMixer ✅
AudioChannelSplitter ✅
AudioChorus ✅
AudioCompressor ✅
AudioDeviceInput ✅
AudioDeviceOutput ✅
AudioDistortion ✅
AudioEcho ✅
AudioEmitter ✅
AudioEqualizer ✅
AudioFader ✅
AudioFilter ✅
AudioFlanger ✅
AudioLimiter ✅
AudioListener ✅
AudioPitchShifter ✅
AudioPlayer ✅
AudioReverb ✅
AudioTextToSpeech ✅
AuroraScriptService ✅
AuroraService ✅
AvatarChatService ✅
AvatarCreationService ✅
Backpack ✅
BadgeService ✅
BasePlayerGui ✅
PlayerGui ✅
StarterGui ✅
BaseRemoteEvent ✅
RemoteEvent ✅
UnreliableRemoteEvent ✅
BaseWrap ✅
WrapDeformer ✅
WrapLayer ✅
WrapTarget ✅
Beam ✅
BindableEvent ✅
BindableFunction ✅
BodyMover ✅
BodyAngularVelocity ✅
BodyForce ✅
BodyGyro ✅
BodyPosition ✅
BodyThrust ✅
BodyVelocity ✅
RocketPropulsion ✅
BodyPartDescription ✅
CaptureService ✅
ChangeHistoryService ✅
CharacterAppearance ✅
BodyColors ✅
CharacterMesh ✅
Clothing ✅
Pants ✅
Shirt ✅
ShirtGraphic ✅
Skin ✅
ClickDetector ✅
DragDetector ✅
Clouds ✅
Collaborator ✅
CollaboratorsService ✅
CollectionService ✅
CommerceService ✅
Configuration ✅
ConfigureServerService ✅
Constraint ✅
AlignOrientation ✅
AlignPosition ✅
AngularVelocity ✅
AnimationConstraint ✅
BallSocketConstraint ✅
HingeConstraint ✅
LineForce ✅
LinearVelocity ✅
PlaneConstraint ✅
Plane ✅
RigidConstraint ✅
RodConstraint ✅
RopeConstraint ✅
SlidingBallConstraint ✅
CylindricalConstraint ✅
PrismaticConstraint ✅
SpringConstraint ✅
Torque ✅
TorsionSpringConstraint ✅
UniversalConstraint ✅
VectorForce ✅
ContextActionService ✅
Controller ✅
HumanoidController ✅
SkateboardController ✅
VehicleController ✅
ControllerBase ✅
AirController ✅
ClimbController ✅
GroundController ✅
SwimController ✅
ControllerManager ✅
CookiesService ✅
CoreScriptDebuggingManagerHelper ✅
CreatorStoreService ✅
CustomEvent ✅
CustomEventReceiver ✅
DataModelMesh ✅
BevelMesh ✅
BlockMesh ✅
CylinderMesh ✅
FileMesh ✅
SpecialMesh ✅
DataModelSession ✅
Debris ✅
DebuggerBreakpoint ✅
DebuggerWatch ✅
Dialog ✅
DialogChoice ✅
Dragger ✅
EditableService ✅
EulerRotationCurve ✅
EventIngestService ✅
ExperienceAuthService ✅
Explosion ✅
FaceControls ✅
FaceInstance ✅
Decal ✅
Texture ✅
FacialAnimationStreamingServiceV2 ✅
Feature ✅
Hole ✅
MotorFeature ✅
FeatureRestrictionManager ✅
Fire ✅
FlagStandService ✅
FloatCurve ✅
FlyweightService ✅
CSGDictionaryService ✅
NonReplicatedCSGDictionaryService ✅
Folder ✅
ForceField ✅
FriendService ✅
FunctionalTest ✅
GamePassService ✅
GenerationService ✅
GenericChallengeService ✅
Geometry ✅
GeometryService ✅
GoogleAnalyticsConfiguration ✅
GuiBase ✅
GuiBase2d ✅
GuiObject ✅
CanvasGroup ✅
Frame ✅
GuiButton ✅
ImageButton ✅
TextButton ✅
GuiLabel ✅
ImageLabel ✅
TextLabel ✅
ScrollingFrame ✅
TextBox ✅
VideoDisplay ✅
VideoFrame ✅
ViewportFrame ✅
LayerCollector ✅
BillboardGui ✅
ScreenGui ✅
GuiMain ✅
SurfaceGuiBase ✅
AdGui ✅
SurfaceGui ✅
GuiBase3d ✅
FloorWire ✅
InstanceAdornment ✅
SelectionBox ✅
PVAdornment ✅
HandleAdornment ✅
BoxHandleAdornment ✅
ConeHandleAdornment ✅
CylinderHandleAdornment ✅
ImageHandleAdornment ✅
LineHandleAdornment ✅
SphereHandleAdornment ✅
WireframeHandleAdornment ❌
ParabolaAdornment ✅
SelectionSphere ✅
PartAdornment ✅
HandlesBase ✅
ArcHandles ✅
Handles ✅
SurfaceSelection ✅
SelectionLasso ✅
SelectionPartLasso ✅
SelectionPointLasso ✅
Path2D ✅
GuidRegistryService ✅
HapticEffect ✅
HeapProfilerService ✅
HeatmapService ✅
HiddenSurfaceRemovalAsset ✅
Highlight ✅
Hopper ✅
HttpRbxApiService ✅
HttpRequest ✅
HttpService ✅
Humanoid ✅
HumanoidDescription ✅
HumanoidRigDescription ✅
IKControl ✅
ILegacyStudioBridge ✅
InputAction ✅
InputBinding ✅
InputContext ✅
InputObject ✅
InsertService ✅
JointInstance ✅
DynamicRotate ✅
RotateP ✅
RotateV ✅
Glue ✅
ManualSurfaceJointInstance ✅
ManualGlue ✅
ManualWeld ✅
Motor ✅
Motor6D ✅
Rotate ✅
Snap ✅
VelocityMotor ✅
Weld ✅
JointsService ✅
KeyboardService ✅
Keyframe ✅
KeyframeMarker ✅
Light ✅
PointLight ✅
SpotLight ✅
SurfaceLight ✅
Lighting ✅
LiveScriptingService ✅
LocalizationTable ✅
LodDataEntity ✅
LogService ✅
LoginService ✅
LuaSourceContainer ✅
AuroraScript ✅
BaseScript ✅
Script ✅
LocalScript ✅
ModuleScript ✅
LuaWebService ✅
MLModelDeliveryService ✅
MarkerCurve ✅
MarketplaceService ✅
MaterialService ✅
MaterialVariant ✅
MemoryStoreService ✅
Message ✅
Hint ✅
Mouse ✅
PlayerMouse ✅
PluginMouse ✅
NetworkMarker ✅
NetworkPeer ✅
NoCollisionConstraint ✅
NotificationService ✅
OperationGraph ✅
PVInstance ✅
BasePart ✅
CornerWedgePart ✅
FormFactorPart ✅
Part ✅
FlagStand ✅
Platform ✅
Seat ✅
SkateboardPlatform ❌
SpawnLocation ✅
WedgePart ✅
Terrain ✅
TriangleMeshPart ✅
MeshPart ✅
PartOperation ✅
IntersectOperation ✅
NegateOperation ✅
UnionOperation ✅
TrussPart ✅
VehicleSeat ✅
Model ✅
Actor ✅
BackpackItem ✅
HopperBin ✅
Tool ✅
Flag ✅
Status ✅
WorldRoot ✅
Workspace ✅
WorldModel ✅
PackageLink ✅
PartOperationAsset ✅
ParticleEmitter ✅
PathfindingLink ✅
PathfindingModifier ✅
PermissionsService ✅
PhysicsService ✅
Player ✅
PlayerHydrationService ✅
Players ✅
Plugin ✅
PluginCapabilities ✅
PluginManager ✅
PluginToolbar ✅
PluginToolbarButton ✅
PointsService ✅
PoseBase ✅
NumberPose ✅
Pose ✅
PostEffect ✅
BloomEffect ✅
BlurEffect ✅
ColorCorrectionEffect ✅
ColorGradingEffect ✅
DepthOfFieldEffect ✅
SunRaysEffect ✅
ProcessInstancePhysicsService ✅
ProximityPrompt ✅
ProximityPromptService ✅
RbxAnalyticsService ✅
ReflectionMetadata ✅
ReflectionMetadataCallbacks ✅
ReflectionMetadataClasses ✅
ReflectionMetadataEnums ✅
ReflectionMetadataEvents ✅
ReflectionMetadataFunctions ✅
ReflectionMetadataItem ✅
ReflectionMetadataClass ✅
ReflectionMetadataEnum ✅
ReflectionMetadataEnumItem ✅
ReflectionMetadataMember ✅
ReflectionMetadataProperties ✅
ReflectionMetadataYieldFunctions ✅
RemoteCursorService ✅
RemoteFunction ✅
RenderingTest ✅
ReplicatedFirst ✅
ReplicatedStorage ✅
RobloxReplicatedStorage ✅
RomarkRbxAnalyticsService ✅
RomarkService ✅
RotationCurve ✅
SafetyService ✅
ScriptDebugger ✅
ScriptProfilerService ✅
ScriptService ✅
Selection ✅
SelectionHighlightManager ✅
SensorBase ✅
AtmosphereSensor ✅
BuoyancySensor ✅
ControllerSensor ✅
ControllerPartSensor ✅
FluidForceSensor ✅
SerializationService ✅
ServiceProvider ✅
DataModel ✅
GenericSettings ✅
AnalysticsSettings ✅
GlobalSettings ✅
UserSettings ✅
ServiceVisibilityService ✅
SessionService ✅
Sky ✅
Smoke ✅
Sound ✅
SoundEffect ✅
ChorusSoundEffect ✅
CompressorSoundEffect ✅
CustomSoundEffect ✅
AssetSoundEffect ✅
ChannelSelectorSoundEffect ✅
DistortionSoundEffect ✅
EchoSoundEffect ✅
EqualizerSoundEffect ✅
FlangeSoundEffect ✅
PitchShiftSoundEffect ✅
ReverbSoundEffect ✅
TremoloSoundEffect ✅
SoundGroup ✅
SoundService ✅
Sparkles ✅
SpawnerService ✅
StandalonePluginScripts ✅
StarterGear ✅
StarterPack ✅
StarterPlayer ✅
StarterPlayerScripts ✅
StarterCharacterScripts ✅
Stats ✅
StatsItem ✅
RunningAverageItemDouble ✅
RunningAverageItemInt ✅
RunningAverageTimeIntervalItem ✅
TotalCountTimeIntervalItem ✅
StudioData ✅
StyleBase ✅
StyleRule ✅
StyleSheet ✅
StyleDerive ✅
StyleLink ✅
SurfaceAppearance ✅
Team ✅
TeamCreateData ✅
TeamCreatePublishService ✅
Teams ✅
TeleportAsyncResult ✅
TeleportOptions ✅
TeleportService ✅
TerrainDetail ✅
TerrainRegion ✅
TestService ✅
TextBoxService ✅
TextChannel ✅
TextChatCommand ✅
BubbleChatConfiguration ✅
ChannelTabsConfiguration ✅
ChatInputBarConfiguration ✅
ChatWindowConfiguration ✅
TextChatMessage ✅
TextChatMessageProperties ✅
BubbleChatMessageProperties ✅
ChatWindowMessageProperties ✅
TextChatService ✅
TextSource ✅
TimerService ✅
TouchInputService ✅
TouchTransmitter ✅
Trail ✅
TweenBase ✅
Tween ✅
TweenService ✅
UGCAvatarService ✅
UIBase ✅
UIComponent ✅
UIConstraint ✅
UIAspectRatioConstraint ✅
UISizeConstraint ✅
UITextSizeConstraint ✅
UICorner ✅
UIDragDetector ✅
UIFlexItem ✅
UIGradient ✅
UILayout ✅
UIGridStyleLayout ✅
UIGridLayout ✅
UIListLayout ✅
UIPageLayout ✅
UITableLayout ✅
UIPadding ✅
UIScale ✅
UIStroke ✅
UniqueIdLookupService ✅
UnvalidatedAssetService ✅
UserService ✅
VRService ✅
VRStatusService ✅
ValueBase ✅
BinaryStringValue ✅
BoolValue ✅
BrickColorValue ✅
CFrameValue ✅
Color3Value ✅
DoubleConstrainedValue ✅
IntConstrainedValue ✅
IntValue ✅
NumberValue ✅
ObjectValue ✅
RayValue ✅
StringValue ✅
Vector3Value ✅
Vector3Curve ✅
VersionControlService ✅
VideoCaptureService ✅
VideoPlayer ✅
VideoService ✅
VirtualInputManager ✅
VisibilityCheckDispatcher ✅
VisualizationMode ✅
VisualizationModeCategory ✅
VisualizationModeService ✅
VoiceChatInternal ✅
VoiceChatService ✅
WeldConstraint ✅
Wire ✅