mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
rules
This commit is contained in:
Joe
parent
a9b4f8e83b
commit
e6efc04756
8494 changed files with 495610 additions and 0 deletions
339
.cursor/rules/roblox/reference/engine/classes/Highlight.yaml
Normal file
339
.cursor/rules/roblox/reference/engine/classes/Highlight.yaml
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
# This file is automatically generated. Please don't edit it manually.
|
||||
# To submit a bug report on the content, see
|
||||
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
||||
|
||||
name: Highlight
|
||||
type: class
|
||||
memory_category: Instances
|
||||
summary: |
|
||||
A visual effect which you can use to call attention to a specific object
|
||||
within an experience.
|
||||
description: |
|
||||
The `Class.Highlight` instance is a visual effect which you can use to call
|
||||
attention to a specific object within an experience. Every highlight effect
|
||||
has a silhouette **outline** that surrounds the object and a solid overlay
|
||||
**interior** that displays over the object. You can customize both of these
|
||||
components independently to modify the highlight's visual appearance.
|
||||
|
||||
<table size="small">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />
|
||||
<figcaption>Base object</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/Adding-Highlight.jpg" />
|
||||
<figcaption>White outline, 50% red interior</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/Overview-Yellow-Outline.jpg" />
|
||||
<figcaption>Yellow outline, black interior</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
Useful applications of the highlight effect include:
|
||||
|
||||
- Providing visual feedback that an object is important and/or interactable.
|
||||
- Making distant objects visible through objects that are closer to the user.
|
||||
- Indicating the current position and status of other characters.
|
||||
|
||||
#### Limitations
|
||||
|
||||
As a performance limit, Studio only displays 255 simultaneous
|
||||
`Class.Highlight` instances on the client at a time. If you exceed this limit,
|
||||
the additional instances are silently ignored. Note that while a
|
||||
`Class.Highlight` with `Class.Highlight.Enabled|Enabled` set to `false`
|
||||
doesn't display, it still takes one of the 255 available slots, so if you plan
|
||||
to permanently disable a `Class.Highlight` instance, it's best to delete it
|
||||
rather than disable it.
|
||||
code_samples: []
|
||||
inherits:
|
||||
- Instance
|
||||
descendants: []
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
properties:
|
||||
- name: Highlight.Adornee
|
||||
summary: |
|
||||
The `Class.Instance` that the `Class.Highlight` is applied to.
|
||||
description: |
|
||||
The `Class.Instance` for which to apply the `Class.Highlight`, used to
|
||||
apply the effect to an `Class.Instance` outside of a child/parent
|
||||
relationship.
|
||||
code_samples: []
|
||||
type: Instance
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Highlight.DepthMode
|
||||
summary: |
|
||||
Controls how the `Class.Highlight` effect displays with respect to other
|
||||
objects in the world.
|
||||
description: |
|
||||
Controls how the `Class.Highlight` effect displays with respect to other
|
||||
objects in the world. You can set this property to one of the following
|
||||
options:
|
||||
|
||||
- `Enum.HighlightDepthMode.AlwaysOnTop|AlwaysOnTop` — Allows the highlight
|
||||
to display regardless if there are objects between the camera and the
|
||||
highlighted object. This means the viewer is always able to see the
|
||||
highlight regardless of what is between the highlighted object and the
|
||||
camera.
|
||||
|
||||
- `Enum.HighlightDepthMode.Occluded|Occluded` — Hides the highlight if
|
||||
there are objects between the camera and the highlighted object. This
|
||||
means the viewer is only able to see the object if there are no
|
||||
obstructing objects between the highlighted object and the camera's
|
||||
view.
|
||||
|
||||
<table size="small">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/DepthMode-AlwaysOnTop.jpg" />
|
||||
<figcaption>DepthMode = AlwaysOnTop</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="50%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/DepthMode-Occluded.jpg" />
|
||||
<figcaption>DepthMode = Occluded</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
code_samples: []
|
||||
type: HighlightDepthMode
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Highlight.Enabled
|
||||
summary: |
|
||||
Sets whether or not the highlight is enabled.
|
||||
description: |
|
||||
Sets whether or not the highlight is enabled. This does not impact
|
||||
performance, but disabled `Class.Highlight` instances will still take one
|
||||
of the 255 available slots. If you plan to permanently disable a
|
||||
`Class.Highlight` instance, it's best to delete it rather than disable it.
|
||||
code_samples: []
|
||||
type: boolean
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Highlight.FillColor
|
||||
summary: |
|
||||
Sets the `Datatype.Color3` value of the highlight's interior.
|
||||
description: |
|
||||
Sets the `Datatype.Color3` value of the highlight's interior.
|
||||
|
||||
<table size="small">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/FillColor-Red.jpg" />
|
||||
<figcaption>FillColor = [255, 100, 50]</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/FillColor-Green.jpg" />
|
||||
<figcaption>FillColor = [0, 255, 125]</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/FillColor-Blue.jpg" />
|
||||
<figcaption>FillColor = [75, 150, 255]</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
code_samples: []
|
||||
type: Color3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Highlight.FillTransparency
|
||||
summary: |
|
||||
Sets the transparency of the highlight's interior.
|
||||
description: |
|
||||
Sets the visibility of the highlight's interior to any value between the
|
||||
default value of **0** (opaque) and **1** (invisible). You can use this
|
||||
property to determine how much of the object's existing color you want
|
||||
viewers to see.
|
||||
|
||||
<table size="small">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/FillTransparency-0.jpg" />
|
||||
<figcaption>FillTransparency = 0</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/FillTransparency-Half.jpg" />
|
||||
<figcaption>FillTransparency = 0.5</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/FillTransparency-1.jpg" />
|
||||
<figcaption>FillTransparency = 1</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Highlight.OutlineColor
|
||||
summary: |
|
||||
Sets the `Datatype.Color3` value of the highlight's outline.
|
||||
description: |
|
||||
Sets the `Datatype.Color3` value of the highlight's outline.
|
||||
|
||||
<table size="small">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/OutlineColor-Red.jpg" />
|
||||
<figcaption>OutlineColor = [255, 100, 50]</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/OutlineColor-Green.jpg" />
|
||||
<figcaption>OutlineColor = [0, 255, 125]</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/OutlineColor-Blue.jpg" />
|
||||
<figcaption>OutlineColor = [75, 150, 255]</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
code_samples: []
|
||||
type: Color3
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
- name: Highlight.OutlineTransparency
|
||||
summary: |
|
||||
Sets the transparency of the highlight's outline.
|
||||
description: |
|
||||
Sets the visibility of the highlight's outline to a value between **0**
|
||||
(opaque) and **1** (transparent).
|
||||
|
||||
<table size="small">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/OutlineTransparency-0.jpg" />
|
||||
<figcaption>OutlineTransparency = 0</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
<figure>
|
||||
<img src="/assets/ui/highlighting-objects/OutlineTransparency-1.jpg" />
|
||||
<figcaption>OutlineTransparency = 1</figcaption>
|
||||
</figure>
|
||||
</td>
|
||||
<td width="30%">
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
code_samples: []
|
||||
type: float
|
||||
tags: []
|
||||
deprecation_message: ''
|
||||
security:
|
||||
read: None
|
||||
write: None
|
||||
thread_safety: ReadSafe
|
||||
category: Data
|
||||
serialization:
|
||||
can_load: true
|
||||
can_save: true
|
||||
capabilities:
|
||||
- Basic
|
||||
methods: []
|
||||
events: []
|
||||
callbacks: []
|
||||
Loading…
Add table
Add a link
Reference in a new issue