mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
93 lines
2.6 KiB
YAML
93 lines
2.6 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: SurfaceGuiBase
|
|
type: class
|
|
memory_category: Instances
|
|
summary: ''
|
|
description: ''
|
|
code_samples: []
|
|
inherits:
|
|
- LayerCollector
|
|
descendants:
|
|
- AdGui
|
|
- SurfaceGui
|
|
tags:
|
|
- NotCreatable
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: SurfaceGuiBase.Active
|
|
summary: ''
|
|
description: |
|
|
This property determines whether the `Class.SurfaceGui` will sink input,
|
|
for example if the parent or `Class.SurfaceGuiBase.Adornee|Adornee` part
|
|
contains a `Class.ClickDetector` class like `Class.DragDetector`.
|
|
|
|
Note that interactive UI elements like `Class.ImageButton|ImageButtons`
|
|
and `Class.TextButton|TextButtons` inside a `Class.SurfaceGui` will only
|
|
receive user input if they are parented to the `Class.PlayerGui` (the
|
|
`Class.SurfaceGui.Adorneee` property can be used to target a part in the
|
|
3D world while the `Class.SurfaceGui` itself remains in the
|
|
`Class.PlayerGui`). Additionally, the part's
|
|
`Class.BasePart.CanQuery|CanQuery` property must be `true` for the
|
|
interactive UI element to receive input.
|
|
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:
|
|
- UI
|
|
- name: SurfaceGuiBase.Adornee
|
|
summary: |
|
|
`Class.BasePart` on which to apply the `Class.SurfaceGui`, overriding the
|
|
default parent association.
|
|
description: |
|
|
`Class.BasePart` on which to apply the `Class.SurfaceGui`, overriding the
|
|
default parent association.
|
|
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:
|
|
- UI
|
|
- name: SurfaceGuiBase.Face
|
|
summary: |
|
|
`Enum.NormalId` face upon which to apply the `Class.SurfaceGui`.
|
|
description: |
|
|
`Enum.NormalId` face of the `Class.SurfaceGui` parent (or its
|
|
`Class.SurfaceGuiBase.Adornee|Adornee`) upon which to apply the
|
|
`Class.SurfaceGui`.
|
|
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:
|
|
- UI
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|