User:Realjame/Class Reference: Difference between revisions
going through class ref still |
got to like M of the class ref |
||
| Line 2: | Line 2: | ||
{{CatUp|Lua Help}} | {{CatUp|Lua Help}} | ||
The Roblox Legacy Documentation features an API Reference that documents all of the classes, data types, enumerations, functions, events, callbacks, and properties that can be used to create games on classic Roblox. | |||
* This page, the Class Reference, documents classes. Classes are core objects and services in Roblox's engine. Classes contain properties, methods, events and callbacks. | |||
* [[Data_Types|Data Types]] are types unique to the Roblox engine, They can contain constructors, properties, and methods. | |||
* [[:Category:Enums|Enums]] are groups of constants that define preset values that you can use with other APIs. Documentation for the generic Enumeration data type is [[Enumeration|here.]] | |||
* [[Function_Dump|Globals]] are functions or properties that you can use in any script. Most globals are native to the Lua programming language while some are exclusive to Roblox's implementation. | |||
If you are looking for more information on undocumented API features, one of your best resources is the Object Browser pane (under the Help menu in Roblox Studio). | |||
If you are looking for information on undocumented | |||
=Parts= | =Parts= | ||
| Line 53: | Line 39: | ||
* {{ClassRefItem|FileMesh}} | * {{ClassRefItem|FileMesh}} | ||
* {{ClassRefItem|Fire}} | * {{ClassRefItem|Fire}} | ||
* {{ClassRefItem|Hole}} | |||
* {{ClassRefItem|Smoke}} | * {{ClassRefItem|Smoke}} | ||
* {{ClassRefItem|Sparkles}} | * {{ClassRefItem|Sparkles}} | ||
| Line 72: | Line 59: | ||
These objects are used in general gameplay of a place. | These objects are used in general gameplay of a place. | ||
* {{ClassRefItem|Camera}} | |||
* {{ClassRefItem|Explosion}} | |||
* {{ClassRefItem|Flag}} | |||
* {{ClassRefItem|Hint}} | |||
* {{ClassRefItem|HopperBin}} | |||
* {{ClassRefItem|Message}} | |||
=Humanoids= | =Humanoids= | ||
| Line 77: | Line 70: | ||
* {{ClassRefItem|Humanoid}} | * {{ClassRefItem|Humanoid}} | ||
* {{ClassRefItem|Accoutrement}} | |||
* {{ClassRefItem|Animation}} | * {{ClassRefItem|Animation}} | ||
* {{ClassRefItem|AnimationTrack}} | * {{ClassRefItem|AnimationTrack}} | ||
* {{ClassRefItem|BodyColors}} | * {{ClassRefItem|BodyColors}} | ||
* {{ClassRefItem|ForceField}} | * {{ClassRefItem|ForceField}} | ||
* {{ClassRefItem|Hat}} | |||
* {{ClassRefItem|Keyframe}} | * {{ClassRefItem|Keyframe}} | ||
* {{ClassRefItem|Pants}} | |||
* {{ClassRefItem|Pose}} | * {{ClassRefItem|Pose}} | ||
* {{ClassRefItem|Skin}} | * {{ClassRefItem|Skin}} | ||
| Line 88: | Line 84: | ||
These objects display graphical elements in 2-dimensional space on the player's screen, in front of the 3D world. | These objects display graphical elements in 2-dimensional space on the player's screen, in front of the 3D world. | ||
* {{ClassRefItem|ScreenGui}} | |||
* {{ClassRefItem|Frame}} | |||
* {{ClassRefItem|ImageButton}} | |||
* {{ClassRefItem|ImageLabel}} | |||
* {{ClassRefItem|TextBox}} | |||
* {{ClassRefItem|TextButton}} | |||
* {{ClassRefItem|TextLabel}} | |||
=3D GUI= | =3D GUI= | ||
| Line 94: | Line 97: | ||
* {{ClassRefItem|ArcHandles}} | * {{ClassRefItem|ArcHandles}} | ||
* {{ClassRefItem|BillboardGui}} | * {{ClassRefItem|BillboardGui}} | ||
* {{ClassRefItem|Handles}} | |||
=Scripting= | =Scripting= | ||
| Line 112: | Line 116: | ||
* {{ClassRefItem|BrickColorValue}} | * {{ClassRefItem|BrickColorValue}} | ||
* {{ClassRefItem|Color3Value}} | * {{ClassRefItem|Color3Value}} | ||
* {{ClassRefItem|CFrameValue}} | |||
* {{ClassRefItem|NumberValue}} | |||
* {{ClassRefItem|ObjectValue}} | |||
=Joints= | =Joints= | ||
These objects bind parts together, sometimes with an extra effect such as a hinge or motor. All classes here inherit from the JointInstance abstract class. | These objects bind parts together, sometimes with an extra effect such as a hinge or motor. All classes here inherit from the JointInstance abstract class. | ||
* {{ClassRefItem|Glue}} | |||
* {{ClassRefItem|Motor}} | |||
* {{ClassRefItem|MotorFeature}} | |||
* {{ClassRefItem|Motor6D}} | |||
=Containers= | =Containers= | ||
| Line 121: | Line 132: | ||
* {{ClassRefItem|Backpack}} | * {{ClassRefItem|Backpack}} | ||
* {{ClassRefItem|Configuration}} | |||
* {{ClassRefItem|DataModel}} | * {{ClassRefItem|DataModel}} | ||
=Services= | =Services= | ||
| Line 132: | Line 144: | ||
==Objects== | ==Objects== | ||
* {{ClassRefItem|BasePart}} | |||
* {{ClassRefItem|Clothing}} | |||
* {{ClassRefItem|Mouse}} | |||
* {{ClassRefItem|NetworkClient}} | * {{ClassRefItem|NetworkClient}} | ||
* {{ClassRefItem|NetworkMarker}} | * {{ClassRefItem|NetworkMarker}} | ||
| Line 137: | Line 152: | ||
* {{ClassRefItem|NetworkServer}} | * {{ClassRefItem|NetworkServer}} | ||
* {{ClassRefItem|NetworkSettings}} | * {{ClassRefItem|NetworkSettings}} | ||
* {{ClassRefItem|PVInstance}} | |||
* {{ClassRefItem|TextureTrail}} | * {{ClassRefItem|TextureTrail}} | ||
Revision as of 14:54, 5 May 2023
|
Work In Progress This is currently being worked on! Check back later for more information... hopefully. |
The Roblox Legacy Documentation features an API Reference that documents all of the classes, data types, enumerations, functions, events, callbacks, and properties that can be used to create games on classic Roblox.
- This page, the Class Reference, documents classes. Classes are core objects and services in Roblox's engine. Classes contain properties, methods, events and callbacks.
- Data Types are types unique to the Roblox engine, They can contain constructors, properties, and methods.
- Enums are groups of constants that define preset values that you can use with other APIs. Documentation for the generic Enumeration data type is here.
- Globals are functions or properties that you can use in any script. Most globals are native to the Lua programming language while some are exclusive to Roblox's implementation.
If you are looking for more information on undocumented API features, one of your best resources is the Object Browser pane (under the Help menu in Roblox Studio).
Parts
As the essential building blocks of Roblox, these objects interact with each other physically. All classes here inherit from the BasePart abstract class.There parts all all rendered in 3D if placed in workspace.
Part modifiers
These objects, when parented to a part, will change the appearance or behavior of the part.
Body movers
Similar to part modifiers, these objects work on the part they are parented to. These objects alter the position, orientation, or movement of a part. All classes here inherit from the BodyMover abstract class.
Gameplay
These objects are used in general gameplay of a place.
Humanoids
These objects are usually found in Humanoids. An example is a Player's Character.
GUI
These objects display graphical elements in 2-dimensional space on the player's screen, in front of the 3D world.
3D GUI
These objects display graphical elements in 3-dimensional space. While they don't interact physically with parts, they are usually attached to parts in some way.
Scripting
These objects are involved in adding scripted functionality to a game.
Values
These objects exist to hold specific value types. They are essential for communicating data between Scripts.
Joints
These objects bind parts together, sometimes with an extra effect such as a hinge or motor. All classes here inherit from the JointInstance abstract class.
Containers
These objects are designed to contain other objects as children. For example, the Workspace holds objects that are simulated as the game runs.
Services
These objects generally operate in the background, and may be helpful with place development. They're unique in that they may only have one instance of themselves, and can be acquired with the GetService method.
Internal
These objects are used internally by the game engine. Generally, trying to use them in Scripts or LocalScripts will result in an error. However, Plugins and the Command Bar in Studio may use them.
Objects
Services
