Classes

259 instance classes in the Asterune Luau API.

Class pages list declared and inherited properties, methods, events, and callbacks.

ServicesCopy link

Access with game:GetService(…).

• AnimationService: Registers and retrieves animation clips by identifier.
• AssetService: Load models and preload content assets.
• Chat: Displays chat messages associated with a Part or character.
• ComponentService: Retrieves registered ECS component definitions.
• CoreGui: Contains the engine's built-in user interfaces.
• Debris: Schedules part destruction after a delay.
• GraphicsService: Reports renderer capabilities and controls graphics quality.
• GuiService: Controls interface focus, selection, navigation, and engine UI state.
• HistoryService: Records and restores editing history.
• HttpService: Server-side HTTP requests.
• InputService: Client input from keyboards, pointers, touchscreens and gamepads.
• Lighting: Controls global lighting, time of day, ambient light, shadows, and fog.
• LocalizationService: Provides locale settings and translation lookup.
• LogService: Stores log history and emits log-message events.
• MaterialService: Retrieves material sets and resolves material overrides.
• NetworkClient: Reports the client's server connection and network statistics.
• NetworkServer: Reports connected clients and server network statistics.
• NetworkService: Reports transport, connection state, traffic, and network timing.
• NetworkSettings: Configures connection, bandwidth, and replication defaults.
• PathfindingService: Creates paths and configures navigation calculations.
• PhysicsService: Registers collision groups and configures collision relationships.
• PhysicsSettings: Configures physics simulation options.
• PlaceService: Reports place metadata and controls place-level operations.
• Players: Contains connected Player instances and manages player lifecycle events.
• PrefabService: Creates and updates instances from reusable prefabs.
• ProximityPromptService: Controls and observes proximity prompts across a place.
• ReflectionService: Exposes class and member metadata.
• ReplicatedFirst: Contains instances replicated before the main place contents.
• ReplicatedStorage: Stores instances replicated from the server to clients.
• ReplicationService: Reports and configures instance replication.
• RunService: Provides frame update signals and execution-context checks.
• ScriptContext: Controls script execution and reports script errors.
• Selection: Reads and changes the current Studio selection.
• ServerScriptService: Contains server scripts and is not replicated to clients.
• ServerStorage: Stores instances available only to the server.
• SoundService: Controls global audio settings, listeners, and audio streams.
• StarterGui: Stores interface templates copied to PlayerGui on spawn.
• StarterPack: Contains Tools copied into a player's Backpack.
• StarterPlayer: Contains player and character templates and their default settings.
• Stats: Provides runtime performance statistics.
• StorageService: Server-side access to host-provided named stores.
• TagService: Queries tagged instances and provides tag change signals.
• Teams: Contains Team instances for a place.
• TestService: Runs automated place tests and provides test assertions and input simulation.
• TextService: Measures and processes text.
• TweenService: Interpolates instance properties over time.
• VRService: Reports VR session state, tracked poses, controllers, and locomotion settings.
• Workspace: Contains rendered and physically simulated instances.

Creatable classesCopy link

Create with Instance.new.

• Accessory: Attaches a wearable model to a character.
• AlignOrientation: Applies torque to align an attachment with a target orientation.
• AlignPosition: Applies force to move an attachment toward a target position.
• AngularVelocity: Applies torque to maintain a target angular velocity.
• Animation: Identifies an animation asset or a local KeyframeSequence.
• AnimationController: Loads and plays animations on a model without a Humanoid.
• AnimationGraph: Stores the serialized states, transitions, parameters, and layers of an animation graph.
• Animator: Loads animation tracks and animation graphs for a character or model.
• AreaLight: Emits light from a rectangular source.
• Atmosphere: Configures atmospheric scattering, absorption, and height-dependent density.
• Attachment: Defines a local position and orientation for effects, constraints, and rig controls.
• Backpack: Contains a player's unequipped Tools.
• BallSocketConstraint: Joins two attachments while allowing rotation within optional angular limits.
• Beam: Renders a textured strip between two attachments.
• BillboardGui: Displays a camera-facing interface at a world position.
• BindableEvent: Dispatches an event between scripts on the same execution side.
• BindableFunction: Calls a callback in another script on the same execution side.
• BlockMesh: Changes a BasePart's rendered mesh to a configurable block.
• BloomEffect: Adds bloom around bright pixels.
• BlurEffect: Applies a full-screen blur.
• BodyColors: Sets character body-part colors.
• BoolValue: Stores a boolean in the instance hierarchy.
• BrickColorValue: Stores a BrickColor in the instance hierarchy.
• Camera: Defines the viewpoint used to render the scene on a client.
• CFrameValue: Stores a CFrame in the instance hierarchy.
• CharacterController: Configures character movement, collision, input, and simulation.
• CharacterMesh: Replaces the mesh and textures of a character body part.
• ChorusSoundEffect: Mixes delayed, modulated copies of an audio signal.
• ChromaticAberrationEffect: Offsets color channels in the rendered image.
• ClickDetector: Detects clicks on a parent part.
• Clouds: Configures procedural cloud coverage, density, altitude, and movement.
• Collider: Defines a collision shape independently of the rendered mesh.
• Color3Value: Stores a Color3 in the instance hierarchy.
• ColorCorrectionEffect: Adjusts image brightness, contrast, saturation, and tint.
• ColorGradingEffect: Applies tonal tints and a color lookup table to the rendered image.
• ComponentDefinition: Defines the typed fields and storage options of an ECS component.
• CompressorSoundEffect: Reduces audio levels above a threshold.
• CylinderMesh: Changes a BasePart's rendered mesh to a cylinder.
• CylindricalConstraint: Allows translation and rotation along a shared attachment axis.
• DataModelMesh: Provides mesh scale, offset, texture, and vertex-color properties.
• Decal: Displays a texture on one face of a BasePart.
• DecalProjector: Projects a decal into a volume in world space.
• DepthOfFieldEffect: Blurs geometry outside the configured focus range.
• DistortionSoundEffect: Distorts an audio signal by applying nonlinear gain.
• DoubleConstrainedValue: Stores a number constrained by minimum and maximum values.
• Dragger: Provides pointer-driven movement of selected Parts.
• EchoSoundEffect: Adds delayed repetitions to an audio signal.
• EqualizerSoundEffect: Adjusts the gain of low, middle, and high audio frequencies.
• ExecutionGroup: Groups scripts into an execution context with serial or parallel scheduling.
• Explosion: Applies a blast once after the instance is parented.
• FileMesh: Provides asset identifiers for externally loaded meshes.
• FilmGrainEffect: Adds procedural grain to the rendered image.
• FlangeSoundEffect: Mixes a signal with a short, modulated delay.
• FogVolume: Adds fog within a bounded region of world space.
• Folder: Groups instances without adding rendering or physical behavior.
• FootPlacementControl: Adjusts a character's feet to match nearby ground geometry.
• ForceField: Protects a character from damage handled by protection-aware APIs.
• Frame: Displays a rectangle and contains GUI instances.
• GeometryPart: Represents a Part with editable polygon geometry.
• Gradient: Defines a color and transparency gradient for an interface element.
• GravityField: Applies directional or radial gravity within a bounded region.
• Health: Stores health, damage, regeneration, and death state independently of movement.
• HingeConstraint: Allows rotation around a shared attachment axis.
• Humanoid: Controls character health, movement, animation, and movement states.
• HumanoidDescription: Stores character body assets, colors, proportions, and clothing settings.
• IKControl: Positions an articulated chain with an inverse-kinematics solver.
• ImageButton: An interactive GUI button rendered with an image.
• ImageLabel: A non-interactive GUI image with shared text-layout properties.
• IntConstrainedValue: Stores an integer constrained by minimum and maximum values.
• IntersectOperation: Represents geometry produced by a solid intersection.
• IntValue: Stores an integer in the instance hierarchy.
• Keyframe: Stores poses at a time within an animation sequence.
• KeyframeMarker: Stores a named animation marker and its string value.
• KeyframeSequence: Stores the keyframes, looping option, and priority of an animation clip.
• LensDistortionEffect: Applies lens distortion and image scaling.
• LightProbeVolume: Configures a volume of probes for indirect lighting.
• LinearVelocity: Applies force to maintain a target linear velocity.
• LineForce: Applies force along the line between two attachments.
• LocalScript: Executes Luau on a client.
• LookAtControl: Rotates an articulated chain toward a target.
• MaterialVariant: Overrides the surface shading of a base material.
• Model: Groups instances for movement, cloning, and destruction.
• ModuleScript: Executes Luau on first require and caches its return value.
• MotionBlurEffect: Blurs the rendered image according to motion.
• Motor6D: Connects two Parts with local transforms and an animation transform.
• NegateOperation: Represents subtractive geometry used by solid modeling operations.
• NoCollisionConstraint: Disables collision between two Parts.
• NumberValue: Stores a number in the instance hierarchy.
• ObjectValue: Stores an Instance reference in the instance hierarchy.
• Pants: Applies a pants texture to a character.
• Part: A physical part with configurable shape, material, and surfaces.
• ParticleAttractor: Applies attraction to particles within a configured region.
• ParticleEmitter: Emits and simulates textured particles.
• ParticleOperator: Stores a custom particle-update shader.
• PathfindingLink: Connects two attachments with a traversable navigation link.
• PathfindingModifier: Overrides navigation costs and traversal within a Part.
• PitchShiftSoundEffect: Changes audio pitch.
• PlaneConstraint: Restricts motion to a plane defined by an attachment.
• PlayerGui: Contains the interfaces displayed to one player.
• PointLight: Emits light in all directions from a point.
• Pose: Stores a local transform and blend settings for an animated joint.
• PrismaticConstraint: Allows translation along a shared attachment axis without relative rotation.
• ProximityPrompt: Displays an interaction prompt near a parent part.
• ReflectionProbe: Captures the environment for local reflections.
• RemoteEvent: Sends asynchronous messages between the server and clients.
• RemoteFunction: Calls a remote callback and waits for its return value.
• RetargetProfile: Maps animation joints between rigs.
• RigidConstraint: Locks the relative transforms of two attachments.
• RodConstraint: Maintains a fixed distance between two attachments.
• RopeConstraint: Limits the distance between two attachments and optionally drives a winch.
• SceneFrame: Renders a separate three-dimensional scene inside an interface.
• ScreenGui: Contains a screen-space interface for one player.
• Script: Executes Luau on the server.
• ScrollingFrame: A scrollable GUI container with shared text-layout properties.
• Seat: Seats a character on contact and reports its Humanoid.
• SelectionBox: Displays a box around an adorned instance.
• SelectionSphere: Displays a sphere around an adorned instance.
• ShaderEffect: Applies a custom full-screen shader.
• Shadow: Configures the shadow rendered for an interface element.
• Shirt: Applies a shirt texture to a character.
• ShirtGraphic: Applies a graphic texture to a character's torso.
• Sky: Configures skybox textures, celestial bodies, and procedural sky appearance.
• Sound: Plays audio with positional or non-positional output.
• SoundGroup: A shared volume-control group for sounds.
• SpawnLocation: Defines a player spawn position and team restrictions.
• SpecialMesh: Changes a BasePart's rendered mesh to a built-in or asset-backed shape.
• SpotLight: Emits light within a cone from a Part face or Attachment.
• SpringConstraint: Applies spring and damping forces between two attachments.
• SpringControl: Applies spring motion to a rig chain.
• Stack: Arranges interface children using flow layout.
• StatsItem: Represents an individual runtime statistic.
• StringValue: Stores a string in the instance hierarchy.
• SunRaysEffect: Adds screen-space light rays from the sun.
• SurfaceAppearance: Configures physically based textures and surface shading for a Part.
• SurfaceGui: Displays an interface on a face of a world-space Part.
• SurfaceLight: Emits light from a selected face of a Part.
• SurfaceShader: Stores a custom surface shader and its parameter layout.
• System: Runs a scheduled ECS callback from a script instance.
• Team: Defines a player team identified by TeamColor.
• TextBox: An editable text field in a GUI.
• TextButton: A text-bearing interactive GUI button.
• TextLabel: Displays text within a GUI rectangle.
• Texture: Repeats a texture across a face of a BasePart.
• Tool: Represents an equippable player tool.
• Torque: Applies torque to an attachment's assembly.
• TorsionSpringConstraint: Applies angular spring and damping torque between two attachments.
• Trail: Renders a strip along the movement history of two attachments.
• TranslationTable: Stores translation entries and locale-specific text.
• TremoloSoundEffect: Modulates the amplitude of an audio signal.
• UIAspectRatioConstraint: Constrains an interface element's width-to-height ratio.
• UICorner: Rounds the corners of an interface element.
• UIGridLayout: Arranges interface children in a grid.
• UIListLayout: Arranges interface children in a horizontal or vertical list.
• UIPadding: Adds padding inside an interface element.
• UIPageLayout: Arranges interface children as navigable pages.
• UIScale: Scales an interface element and its descendants.
• UISizeConstraint: Constrains an interface element's minimum and maximum size.
• UIStroke: Draws a stroke around text or an interface border.
• UITextSizeConstraint: Constrains automatically scaled text size.
• UnionOperation: Represents geometry produced by a solid union.
• UniversalConstraint: Connects two attachments with two rotational degrees of freedom.
• Vector3Value: Stores a Vector3 in the instance hierarchy.
• VectorForce: Applies a constant force in a selected coordinate frame.
• VehicleSeat: A seat that provides vehicle movement input and physical velocity.
• VignetteEffect: Darkens the edges of the rendered image.
• WeldConstraint: Locks the relative position and orientation of two Parts.

Other classesCopy link

Abstract base classes and engine-created instances.

• Accoutrement: Provides the attachment transform inherited by wearable instances.
• BackpackItem: Defines the abstract inventory-item family used by class placement rules.
• BasePart: Defines physical properties, transforms, and contact events for parts.
• BasePlayerGui: Provides the base class for player interface containers.
• BaseScript: Provides the base class for executable script instances.
• BevelMesh: Provides the base class for meshes with bevel and roundness settings.
• CharacterAppearance: Provides the base class for character appearance instances.
• Clothing: Provides the base class for character clothing textures.
• Constraint: Provides the base class for physical constraints and force actuators.
• DataModel: Contains the place hierarchy and provides access to services.
• FaceInstance: Provides the face selection inherited by surface textures.
• GuiBase: Provides the base class for interface instances.
• GuiBase2d: Provides the base class for two-dimensional interfaces.
• GuiBase3d: Defines the abstract family for three-dimensional adornment interfaces.
• GuiButton: Provides activation events and selection behavior for buttons.
• GuiLabel: Provides the base class for non-button interface labels.
• GuiLayerCollector: Provides the base class for interface roots.
• GuiObject: Defines interface layout, appearance, input, and selection properties.
• Instance: The base class for instances in a place.
• Light: Provides shared brightness, color, range, and shadow settings for local lights.
• LuaSourceContainer: Provides source storage inherited by script classes.
• Mouse: Reports pointer position, target, and mouse-button events.
• PartAdornment: Defines an abstract Part-adornment class for reflection.
• PartOperation: Provides the base class for solid-modeling results.
• Player: Represents a connected player and their session state.
• PlayerMouse: Provides the mouse input interface returned for a local player.
• PlayerScripts: Contains the client's player scripts.
• PostEffect: Provides the base class for post-processing effects.
• PVAdornment: Provides the base class for world-space selection adornments.
• PVInstance: Provides the base class for instances with a spatial pivot.
• RigControl: Provides the base class for procedural rig controls.
• SelectionLasso: Defines the abstract selection-lasso family for reflection.
• SlidingBallConstraint: Allows translation along one axis and ball-socket rotation.
• SoundEffect: Provides enablement and processing order for audio effects.
• StarterCharacterScripts: Contains scripts copied into each spawned character.
• StarterPlayerScripts: Contains scripts copied into each player's PlayerScripts.
• Terrain: Stores and edits voxel terrain and water.
• TriangleMeshPart: Provides the base class for Parts with triangle-mesh geometry.
• UIBase: Provides the base class for interface layout and styling instances.
• UIComponent: Provides the base class for interface decorators and layout components.
• UIConstraint: Provides the base class for interface size constraints.
• UIGridStyleLayout: Provides common alignment and sorting settings for grid layouts.
• UILayout: Provides the base class for interface layout components.
• ValueBase: Provides the base class for instances that store a single value.
• WorldRoot: Provides spatial queries and world-level physics operations.