PcoWSkbVqDnWTu_dm2ix
Collapse Sidebar

GetAttribute

Attributes are not currently enabled, so this API member may have no effect, emit a warning or raise an error. Do not use it in new work.

This function returns the attribute which has been assigned to the given name. If no attribute has been assigned then nil is returned.

For example, the following code snippet will set the value of the instance’s InitialPostion attribute. Note that this code sample does not define instance:

local initialPosition = instance:GetAttribute("InitialPosition")

See also

  • Instance/SetAttribute, sets the attribute with the given name to the given value
  • Instance/GetAttributes, returns a dictionary of string → variant pairs for each of the instance’s attributes
  • Instance/AttributeChanged, fires whenever an attribute is changed on the instance
  • Instance/GetAttributeChangedSignal, returns an event that fires when the given attribute changes

Parameters

Name Type Default Description

The name of the attribute being retrieved

Returns

Return Type Summary

The attribute which has been assigned to the given name. If no attribute has been assigned then nil is returned