Reference API Roblox

Engine API

Website

Related

Reference API Roblox

StringValue

A container object for a single string.

Memory categoryInstances

Member index 3

HistoryMember
486Value: string
462Changed(value: string)
553changed(value: string)
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: 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()
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

A StringValue is an object whose purpose is to store a single Lua string. The length of the string can't be more than 200,000 characters (this will cause a "String too long" error). Like all "-Value" objects, this single value is stored in the Value property. The Changed event for this (and other objects like it) will fire with the new value being stored in the object, instead of a string representing the property being changed.

If the string is too long to be displayed in the Value field within Properties window, it will partially show the string contents followed by an ellipsis (...).

History 10

Members 3

Changed

Parameters (1)
valuestring

Fired whenever the StringValue.Value of the StringValue is changed. It will run with the new value being stored in the argument object, instead of a string representing the property being changed.

This event, like other changed events, can be used to track when an StringValue changes and to track the different values that it may change to.

For instance, this may be useful in games that rely on StringValues to track values such as NPC or item names.

Equivalent changed events exist for similar objects, such as NumberValue and BoolValue, depending on what object type best suits the need.

Thread safetyUnsafe

History 2

Value

TypeDefault
string

The stored string.

Thread safetyReadSafe
CategoryData
Loaded/Savedtrue

History 3

  • 486 Change ThreadSafety of Value from ReadOnly to ReadSafe
  • 462 Change ThreadSafety of Value from to ReadOnly
  • 47 Add Value

changed

Parameters (1)
valuestring
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