# 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: SelectionSphere
type: class
memory_category: Instances
summary: |
  Renders a 3D sphere around its `Class.PVAdornment.Adornee|Adornee`.
description: |
  `SelectionSphere` renders a 3D sphere around its
  `Class.PVAdornment.Adornee|Adornee` when it is a descendant of the
  `Class.Workspace` or anywhere where GUI objects are rendered. The sphere's
  geometry consists of a ring/outline in addition to a surface.
  `SelectionSphere` does not capture any form of input; it is solely a visual
  effect.

  For an outline/fill overlay effect which covers non‑primitive geometry such as
  that of a `Class.MeshPart`, see `Class.Highlight`.
code_samples: []
inherits:
  - PVAdornment
descendants: []
tags: []
deprecation_message: ''
properties:
  - name: SelectionSphere.SurfaceColor
    summary: |
      A `Datatype.BrickColor` version of
      `Class.SelectionBox.SurfaceColor3|SurfaceColor3`.
    description: |
      A `Datatype.BrickColor` version of
      `Class.SelectionBox.SurfaceColor3|SurfaceColor3`.
    code_samples: []
    type: BrickColor
    tags:
      - Hidden
      - NotReplicated
      - Deprecated
    deprecation_message: |
      This property is deprecated in favor of
      `Class.SelectionSphere.SurfaceColor3|SurfaceColor3` which uses the more
      precise `Datatype.Color3` data type instead of a `Datatype.BrickColor`
      used by this property.
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: false
    capabilities:
      - Basic
      - UI
  - name: SelectionSphere.SurfaceColor3
    summary: |
      Determines the color of the sphere's surface.
    description: |
      `SurfaceColor3` determines the color of the sphere's surface.

      See also `Class.SelectionSphere.Color3|Color3`, a property of the
      superclass `Class.GuiBase3d` which controls the color of the outline
      rather than the surface faces.
    code_samples: []
    type: Color3
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Basic
      - UI
  - name: SelectionSphere.SurfaceTransparency
    summary: |
      Determines the transparency of the sphere's surface.
    description: |
      `SurfaceTransparency` determines the transparency of the sphere's surface,
      similar to the way `Class.BasePart.Transparency` works. By default, this
      property is `1` which causes the surfaces to be invisible.

      See also `Class.SelectionSphere.Transparency|Transparency`, a property of
      the superclass `Class.GuiBase3d` which controls the transparency of the
      outline rather than the surface.
    code_samples: []
    type: float
    tags: []
    deprecation_message: ''
    security:
      read: None
      write: None
    thread_safety: ReadSafe
    category: Appearance
    serialization:
      can_load: true
      can_save: true
    capabilities:
      - Basic
      - UI
methods: []
events: []
callbacks: []