Class
RayValue
A container object for a single Ray.
A RayValue is an object whose purpose is to store a single Ray. Similar to
CFrameValue, a RayValue's stored ray cannot be viewed or edited within the
Properties window within studio. Instead, use the Command bar to get and set
the value of these objects. For example, you can use a line like the one below
to create a new RayValue named "Value" within the Workspace. It
creates a ray at (0, 50, 0) and it faces in the positive-X direction.
Instance.new("RayValue").Value = Ray.new(Vector3.new(0, 50, 0), Vector3.new(10, 0, 0))
Since there is no trivial way to edit rays within Studio, sometimes it is
better to use a CFrameValue instead (which can be changed through a part or
the camera). You can reconstruct a ray from a CFrame using
Ray.new(cf.p, cf.lookVector * dist), where cf is a given CFrame and dist
is the length of the Ray you want to construct.
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.
Properties 1#
Events 2#
| Changed | Fired when RayValue.Value is changed. |
| changed | Deprecated |
Changed(value: Ray)#
This event fires whenever the RayValue.Value property 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 RayValue changes and to track the different values that it may change to.
Equivalent changed events exist for similar objects, such as
NumberValue and StringValue, depending on what object type
best suits the need.
| Name | Type | Default | Description |
|---|---|---|---|
value | Ray | The value after the change. |
changed(value: Ray)#
DeprecatedDeprecated
Deprecated. This event is a deprecated variant of RayValue.Changed which
should be used instead.
| Name | Type | Default | Description |
|---|---|---|---|
value | Ray |
Inherited members#
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild