RayValue
A container object for a single Ray.
Memory category | Instances |
---|
Member index 3
Description
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.
History 11
- 553 Change PreferredDescriptor of changed from to Changed
- 553 Change Default of Value from to Ray({0, 0, 0}, {0, 0, 0})
- 486 Change ThreadSafety of Value from ReadOnly to ReadSafe
- 462 Change ThreadSafety of changed from to Unsafe
- 462 Change ThreadSafety of Changed from to Unsafe
- 462 Change ThreadSafety of Value from to ReadOnly
- 335 Change Superclass of RayValue from Instance to ValueBase
- 50 Add changed
- 47 Add Changed
- 47 Add Value
- 47 Add RayValue
Members 3
Changed
Parameters (1) | |
---|---|
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.
Thread safety | Unsafe |
---|
Value
Type | Default | |
---|---|---|
Ray | {0, 0, 0}, {0, 0, 0} |
The stored Ray.
Thread safety | ReadSafe |
---|---|
Category | Data |
Loaded/Saved | true |
changed
Parameters (1) | |
---|---|
value | Ray |
Thread safety | Unsafe |
---|