API reference
API reference
Select your platform
No SDKs available
No versions available

StringAttribute Class

Extends TypedAbstractAttribute
 Modifiers: final
An attribute that stores a String value.
XML Usage Example: 
<component name="MyComponent">
  <StringAttribute name="name" defaultValue="Player" />
</component>

Signature

class StringAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: String) : TypedAbstractAttribute<String>

Constructors

StringAttribute ( keyString , key , component , initialValue )
Signature 
constructor(keyString: String, key: Int, component: ComponentBase, initialValue: String)
Parameters
keyString: String
  The string key for this attribute
key: Int
  The integer key for this attribute
component: ComponentBase
  The component this attribute belongs to
initialValue: String
  The initial value for this attribute
Returns

Properties

value : String
[Get][Set]
Signature 
var value: String

Functions

checkIfComponentIsOld ()
Signature 
fun checkIfComponentIsOld()
checkIfComponentIsRecycled ()
Signature 
fun checkIfComponentIsRecycled()
get ()
Signature 
open override fun get(): Any
Returns
Any
getValue ( thisRef , property )
Signature 
operator fun getValue(thisRef: Any?, property: KProperty<*>): String
Parameters
thisRef: Any?
property: KProperty
Returns
String
keyName ()
Signature 
fun keyName(): String
Returns
String
set ( value )
Signature 
open override fun set(value: Any)
Parameters
value: Any
setValue ( thisRef , property , value )
Signature 
operator fun setValue(thisRef: Any?, property: KProperty<*>, value: String)
Parameters
thisRef: Any?
property: KProperty
value: String
Did you find this page helpful?
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta