System
Runs a scheduled ECS callback from a script instance.
- Creatable
Instance.new("System")- Inherits
- BaseScriptLuaSourceContainerInstance
- Replication
- Standard
Behavior
System runs a scheduled ECS callback from a script instance. Source must return
System.define(options, run). Systems run under ServerScriptService on the server
and PlayerScripts on the client. StarterPlayerScripts contains client templates.
Systems outside these containers do not run.
See Systems and scheduling for phases, ordering, intervals, parallel execution, and failure conditions.
Summary
Whether this System is excluded from execution.
The Luau source code stored by this script instance.
Returns this instance if it is an ExecutionGroup.
Properties
Disabled
System.Disabled: boolean = falseWhether this System is excluded from execution. Set to false to allow scheduling.
Source
System.Source: string = ""The Luau source code stored by this script instance.
Methods
GetExecutionGroup
System:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying