Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ObjectValue

A container object for a reference to another instance.

Memory categoryInstances

Member index 3

HistoryMember
553Value: Instance
462Changed(value: Instance)
553changed(value: Instance)
inherited from Instance
553Archivable: bool
670Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
670Sandboxed: bool
680UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: 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
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Description

Stores a single reference to another object. If this object is duplicated within Studio and the value refers to an object also being copied, then the new ObjectValue points to the copied object instead of the original. Otherwise, the same value is kept. Copying and pasting this object clears the value field.

You can set the value within Studio like other reference-type fields (such as Model.PrimaryPart): click the field within the Properties window, then click the object you wish to set it to within the game view or Explorer window. You can clear the field (set it to nil) by clicking the X that appears when you click the field.

Like all ValueBase objects, this single value is stored in the Value property. The Changed event fires with the new value being stored in the object, instead of a string representing the property being changed.

If streaming is enabled, the Value property is nil until the referenced object streams in, at which point the Changed event fires.

History 12

Members 3

Changed

Parameters (1)
valueInstance

Fires whenever the ObjectValue.Value changes. It runs with the new value being stored in the argument object, instead of a string representing the property being changed.

Listening for the Changed signal can be useful in games that use ObjectValues to track game state, such as an RPG targeting system.

Thread safetyUnsafe

History 2

Value

TypeDefault
Instance

Holds a reference to an instance.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 5

changed

Parameters (1)
valueInstance
This event is deprecated. It exists only for backward compatibility, and should not be used for new work. Changed should be used instead.
Thread safetyUnsafe

History 3

Tags: [Deprecated]

Settings