Creator Guide
English
English
  • 🚩Introduction to OVERDARE
  • 🐤Get Started
    • OVERDARE App
    • OVERDARE Studio
  • 📌Policy
    • Community Guidelines
    • UGC Creation Guidelines
    • Guidelines on the External Use of UGC
    • Logo Usage Guidelines
    • Intellectual Property Rights Policy
    • Reporting Guidelines
    • Guidelines on Disputing Suspensions and Bans
    • Creator Payout Policy
    • Monetization Guidelines
  • 🏰Studio Manual
    • Studio Interface
    • Asset Import
    • Coordinate System
    • Game Settings
    • Studio Test Play
    • World Publish
    • Collaboration
    • Script Editor
    • Align Tool
    • Animation Editor
    • Material Manager
    • Collision Groups
    • Tag Editor
    • Payout Guideline
    • Object
      • Part
      • Model
      • Character
        • Humanoid Description
      • Camera
      • Physics
      • Lighting
      • Tool
      • VFX
      • Sound
      • GUI
  • 📝Script Manual
    • Script Overview
    • Basic Guide to Lua
    • Coding Style
    • Object Reference
    • Event
    • Server-Client Communication
    • BindableEvent
    • Value Objects
    • Mobile Input Handling
    • Tween
    • Breakpoint
    • Module Script
    • TPS Strafing System
    • Saving & Loading Data
    • Unity Developer Guide
  • 📚API Reference
    • Enums
      • ActuatorRelativeTo
      • AnimationPriority
      • AspectType
      • AssetTypeVerification
      • BorderMode
      • CameraMode
      • CameraType
      • ContextActionResult
      • CoreGuiType
      • DominantAxis
      • EasingDirection
      • EasingStyle
      • ForceLimitMode
      • HttpCompression
      • HttpContentType
      • HumanoidDisplayDistanceType
      • HumanoidStateType
      • KeyCode
      • Material
      • MaterialPattern
      • NormalId
      • ParticleEmitterShape
      • ParticleEmitterShapeInOut
      • ParticleEmitterShapeStyle
      • ParticleFlipbookLayout
      • ParticleFlipbookMode
      • ParticleOrientation
      • PartType
      • PlaybackState
      • RaycastFilterType
      • RollOffMode
      • RotationType
      • UserInputState
      • UserInputType
      • VelocityConstraintMode
    • DataTypes
      • BlendSpaceSampleSata
      • BrickColor
      • CFrame
      • Color3
      • ColorSequence
      • ColorSequenceKeypoint
      • Content
      • Enum
      • EnumItem
      • NumberRange
      • NumberSequence
      • NumberSequenceKeypoint
      • OverlapParams
      • PhysicalProperties
      • Ray
      • RaycastParams
      • RaycastResult
      • ScriptConnection
      • ScriptSignal
      • TweenInfo
      • Udim
      • Udim2
      • Vector2
      • Vector3
    • Classes
      • Animation
      • AngularVelocity
      • AnimationTrack
      • Animator
      • Atmosphere
      • Attachment
      • Backpack
      • BackpackItem
      • BasePart
      • BaseScript
      • Beam
      • BindableEvent
      • BlendSpace
      • BoolValue
      • Bone
      • Camera
      • CharacterMesh
      • CollectionService
      • Constraint
      • ContextActionService
      • CoreGui
      • DataStore
      • DataModel
      • DataStoreGetOptions
      • DataStoreIncrementOptions
      • DataStoreInfo
      • DataStoreKeyPages
      • DataStoreKeyInfo
      • DataStoreService
      • DataStoreListingPages
      • DataStoreSetOptions
      • FormFactorPart
      • Frame
      • Folder
      • GlobalDataStore
      • GuiBase2d
      • GuiButton
      • GuiObject
      • HttpService
      • Humanoid
      • HumanoidDescription
      • ImageButton
      • ImageLabel
      • InputObject
      • IntValue
      • LayerCollector
      • Instance
      • Light
      • Lighting
      • LinearVelocity
      • LocalScript
      • LuaSourceContainer
      • MaterialService
      • MaterialVariant
      • MeshPart
      • Model
      • ModuleScript
      • Mouse
      • OrderedDataStore
      • Pages
      • Part
      • ParticleEmitter
      • PhysicsService
      • Player
      • PlayerGui
      • Players
      • PlayerScripts
      • PointLight
      • PVInstance
      • ReplicatedStorage
      • RemoteEvent
      • ScreenGui
      • RunService
      • Script
      • ServerStorage
      • ServiceProvider
      • Skeleton
      • ServerScriptService
      • Sound
      • SoundService
      • SoundGroup
      • SpotLight
      • SpawnLocation
      • StarterCharacterScripts
      • StarterPack
      • StarterGui
      • StarterPlayer
      • StarterPlayerScripts
      • StringValue
      • SurfaceGui
      • SurfaceGuiBase
      • Team
      • Teams
      • TextLabel
      • TextButton
      • Tool
      • Trail
      • Tween
      • TweenService
      • TweenBase
      • UIAspectRatioConstraint
      • UserGameSettings
      • UserInputService
      • UserSettings
      • VectorForce
      • Workspace
      • WrapLayer
      • WorldRoot
      • WrapTarget
  • 🅰️OVERDARE Glossary
  • 📰Release Note
Powered by GitBook
On this page
  • Overview
  • How to Use
  • Class Inheritance Hierarchy

API Reference

PreviousUnity Developer GuideNextEnums

Last updated 21 days ago

Overview

This API Reference is a key document that provides precise usage details for properties, functions, and events used in scripts. When designing or implementing game features, the API Reference helps developers quickly and accurately integrate the necessary functionalities.

If you liken the process of writing a script to cooking, the script represents the cooking process, whilethe API Reference serves as the cookbook. Just as knowing the right ingredients and tools makes cooking easier, using the API Reference simplifies and streamlines script development. It helps implement desired features accurately while reducing development time.

How to Use

For example, if you want to display a message when a player joins the game, refer to the API Reference for the PlayerAdded event and the Connect method. Based on this, you can write a script like the following:

local Players = game:GetService("Players")

local function EnterPlayer(player)
    print(player.Name .. " has joined the game!")
end
Players.PlayerAdded:Connect(EnterPlayer)

Whenever you have questions during development or feel unsure about how to implement a specific feature, always refer to the API Reference as your first point of reference. It will not only help with writing code but also significantly enhance the overall productivity and quality of game development.

Class Inheritance Hierarchy

├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ │ ├─ │ └─ ├─ ├─ ├─ │ ├─ │ ├─ │ └─ ├─ JointInstance │ └─ │ └─ Motor6D ├─ │ ├─ │ │ ├─ │ │ │ ├─ │ │ │ │ └─ │ │ └─ │ ├─ │ └─ ├─ │ └─ ├─ ├─ ├─ │ └─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ │ └─ ├─ ├─ ├─ │ ├─ │ │ ├─ │ │ └─ │ └─ ├─ ├─ ├─ ├─ │ ├─ │ └─ ├─ │ ├─ │ └─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ ├─ Explosion ├─ Fire ├─ Sparkles ├─ │ ├─ │ │ └─ ├─ ├─ ├─ │ ├─ │ └─ ├─ ├─ ValueBase │ ├─ │ ├─ │ ├─ │ └─ ├─ GenericSettings │ ├─ ├─ └─

└─

├─ │ ├─ │ ├─ │ │ ├─ │ │ └─ │ ├─ │ ├─ │ └─ │ ├─ │ └─ │ └─ └─

📚
Instance
TweenService
RunService
MaterialService
PhysicsService
SoundService
UserInputService
ContextActionService
DataStoreService
HttpService
Players
ReplicatedStorage
ServerScriptService
ServerStorage
StarterGui
StarterPlayer
StarterPlayerScripts
StarterCharacterScripts
MaterialService
CollectionService
Constraint
AngularVelocity
LinearVelocity
VectorForce
Motor
PVInstance
BasePart
Part
FormFactorPart
SpawnLocation
MeshPart
Model
Skeleton
Attachment
Bone
Animation
AnimationTrack
TweenBase
Tween
Player
StarterPack
PlayerGui
PlayerScripts
BindableEvent
RemoteEvent
Camera
InputObject
Mouse
WrapLayer
WrapTarget
CharacterMesh
Humanoid
HumanoidDescription
Folder
ServiceProvider
DataModel
Atmosphere
MaterialVariant
LuaSourceContainer
BaseScript
Script
LocalScript
ModuleScript
Sound
UIAspectRatioConstraint
BlendSpace
GlobalDataStore
DataStore
OrderedDataStore
Pages
DataStoreKeyPages
DataStoreListingPages
DataStoreGetOptions
DataStoreSetOptions
DataStoreIncrementOptions
DataStoreInfo
DataStoreKeyInfo
ParticleEmitter
Beam
Trail
Backpack
BackpackItem
Tool
Team
Lighting
Light
PointLight
SpotLight
SoundGroup
BoolValue
IntValue
NumberValue
StringValue
UserSettings
UserGameSettings
CoreGui
WorldRoot
Workspace
GuiBase2d
GuiObject
Frame
GuiButton
ImageButton
TextButton
ImageLabel
TextLabel
LayerCollector
ScreenGui
SurfaceGuiBase
SurfaceGui