/
Frame.yaml
42 lines (42 loc) · 1.36 KB
/
Frame.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
name: Frame
type: class
category: GUI
memory_category: Gui
summary: |
A GuiObject that renders as a plain rectangle, generally used as a container.
description: |
Frame is a `Class.GuiObject` that renders as a plain rectangle with no other
content. They are the simplest concrete example of a `Class.GuiObject`, as
they provide very little additional functionality (`Class.Frame.FrameStyle`).
Despite this, Frames are useful as containers for other
`Class.GuiObject|GuiObjects`, such as `Class.TextLabel`, `Class.ImageLabel`.
The key benefit to using a Frame over a `Class.Folder` as a container object
is the ability to further manipulate the `Class.GuiObject.Size` and
`Class.GuiObject.Position` of any descendant `Class.GuiObject`s.
code_samples:
inherits:
- GuiObject
tags: []
deprecation_message: ''
properties:
- name: Frame.Style
summary: |
Sets what the frame looks like from a selection of pre-determined styles.
description: |
Sets what the frame looks like from a selection of pre-determined styles.
See `Enum.FrameStyle` for a description of each style.
code_samples:
type: FrameStyle
tags: []
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Data
serialization:
can_load: true
can_save: true
methods: []
events: []
callbacks: []