mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
49 lines
1.4 KiB
YAML
49 lines
1.4 KiB
YAML
# 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: SurfaceSelection
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Highlights a face of a surface in a configurable color.
|
|
description: |
|
|
A `SurfaceSelection` highlights a particular face
|
|
(`Class.SurfaceSelection.TargetSurface|TargetSurface`) of its
|
|
`Class.PartAdornment.Adornee|Adornee`. The highlight's color is configurable
|
|
using the `Class.GuiBase3d.Color3|Color3` property.
|
|
|
|
The `SurfaceSelection` object is typically used by `Class.Plugin` when the
|
|
user is selecting the face of a `Class.BasePart`.
|
|
code_samples: []
|
|
inherits:
|
|
- PartAdornment
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: SurfaceSelection.TargetSurface
|
|
summary: |
|
|
Sets which side the SurfaceSelection will appear on, on the adorned
|
|
`Class.BasePart`.
|
|
description: |
|
|
Sets which side the SurfaceSelection will appear on, on the adorned
|
|
`Class.BasePart`.
|
|
code_samples: []
|
|
type: NormalId
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: Data
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Basic
|
|
- UI
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|