API:Ref

A Ref (short for Reference) is used to indicate a property that refers to an Instance. It's value might be nil when being retrieved, depending on the context of it's retrieval.
It is also used in the context of a method that can either return an Instance or nil.
Similarly to Variant, a Ref can refer to multiple types.

Examples

  • The Clone method of Object Icon.pngInstance returns a Ref<Instance>, because it can return nil if the object's Archivable property is set to false.
  • The Parent property of Object Icon.pngInstance is a Ref<Instance> because it can be nil if the object doesn't have a Parent.
  • The Value property of Value icon.pngObjectValue is a Ref<Instance> because it can be set to be an Instance, or nil.
  • The Character property of Player icon.pngPlayer is a Ref<Model> because the reference to it's character model may be nil if the character hasn't loaded yet.

Referenced by