mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 22:11:38 +00:00
88 lines
2.5 KiB
YAML
88 lines
2.5 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: StringValue
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
A container object for a single string.
|
|
description: |
|
|
Stores a single [Luau string](https://luau.org/syntax#string-literals). The
|
|
length of the string can't be more than 200,000 characters; anything longer
|
|
causes a `String too long` error.
|
|
|
|
If the string is too long to be displayed in the **Value** field within the
|
|
**Properties** window, it shows partial string contents and an ellipsis (...).
|
|
|
|
Like all `Class.ValueBase` objects, this single value is stored in the
|
|
`Class.StringValue.Value|Value` property. The `Changed` event fires with the
|
|
new value being stored in the object, instead of a string representing the
|
|
property being changed.
|
|
code_samples:
|
|
- Changed-Event
|
|
inherits:
|
|
- ValueBase
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: StringValue.Value
|
|
summary: |
|
|
The stored string.
|
|
description: |
|
|
The stored <a href="../../../luau/strings.md">string</a>.
|
|
code_samples: []
|
|
type: string
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities: []
|
|
methods: []
|
|
events:
|
|
- name: StringValue.Changed
|
|
summary: |
|
|
Fires whenever `Class.StringValue.Value` is changed.
|
|
description: |
|
|
Fires whenever the `Class.IntValue.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
|
|
`StringValues` to track values like NPC names or item descriptions.
|
|
code_samples:
|
|
- how-to-use-stringvalue-changed
|
|
parameters:
|
|
- name: value
|
|
type: string
|
|
default:
|
|
summary: |
|
|
The new value after the change.
|
|
tags: []
|
|
deprecation_message: ''
|
|
security: None
|
|
capabilities: []
|
|
- name: StringValue.changed
|
|
summary: ''
|
|
description: ''
|
|
code_samples: []
|
|
parameters:
|
|
- name: value
|
|
type: string
|
|
default:
|
|
summary: ''
|
|
tags:
|
|
- Deprecated
|
|
deprecation_message: |
|
|
This deprecated event is a variant of `Class.StringValue.Changed` which
|
|
should be used instead.
|
|
security: None
|
|
capabilities: []
|
|
callbacks: []
|