Reference API Roblox

Engine API

Website

Related

Reference API Roblox

PlayerControlState

This class is not browsable. It is not visible in Studio's object browser.
Tags: [NotBrowsable]

Member index 16

HistoryMember
735Owner: Player
735AddBoolField(name: string, defaultValue: bool = false): null
735AddCFrameField(name: string, defaultValue: CFrame = 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1): null
735AddInstanceField(name: string): null
735AddIntField(name: string, defaultValue: double = 0, min: double = 0, max: double = 255): null
735AddNumberField(name: string, defaultValue: double = 0, min: double = 0, max: double = 1): null
735AddUnitVector3Field(name: string, defaultValue: Vector3 = 0, 0, 0): null
735AddVector2Field(name: string, defaultValue: Vector2 = 0, 0, maxMagnitude: double = 1): null
735AddVector3Field(name: string, defaultValue: Vector3 = 0, 0, 0, maxMagnitude: double = 100): null
735GetChangedState(prev: StateReferenceFrame = PreviousState, next: StateReferenceFrame = CurrentState): Dictionary
735GetReplicationWeight(): double
735GetState(ref: StateReferenceFrame = CurrentState): Dictionary
735SetField(name: string, value: Variant): null
735UpdateFields(state: Dictionary): null
735OnStateChanged()
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

History 17

Members 16

AddBoolField

Parameters (2)Default
namestring
defaultValueboolfalse
Returns (1)
null

History 1

AddCFrameField

Parameters (2)Default
namestring
defaultValueCFrame0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1
Returns (1)
null

History 1

AddInstanceField

Parameters (1)
namestring
Returns (1)
null

History 1

AddIntField

Parameters (4)Default
namestring
defaultValuedouble0
mindouble0
maxdouble255
Returns (1)
null

History 1

AddNumberField

Parameters (4)Default
namestring
defaultValuedouble0
mindouble0
maxdouble1
Returns (1)
null

History 1

AddUnitVector3Field

Parameters (2)Default
namestring
defaultValueVector30, 0, 0
Returns (1)
null

History 1

AddVector2Field

Parameters (3)Default
namestring
defaultValueVector20, 0
maxMagnitudedouble1
Returns (1)
null

History 1

AddVector3Field

Parameters (3)Default
namestring
defaultValueVector30, 0, 0
maxMagnitudedouble100
Returns (1)
null

History 1

GetChangedState

Parameters (2)Default
prevStateReferenceFramePreviousState
nextStateReferenceFrameCurrentState
Returns (1)
Dictionary

History 1

GetReplicationWeight

Parameters (0)
No parameters.
Returns (1)
double

History 1

GetState

Parameters (1)Default
refStateReferenceFrameCurrentState
Returns (1)
Dictionary

History 1

OnStateChanged

Parameters (0)
No parameters.

History 1

Owner

TypeDefault
Player

History 1

SetField

Parameters (2)
namestring
valueVariant
Returns (1)
null

History 1

UpdateFields

Parameters (1)
stateDictionary
Returns (1)
null

History 1

Settings