rojo/.cursor/rules/roblox/reference/engine/classes/PointLight.yaml
2026-02-02 12:08:47 -06:00

59 lines
1.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: PointLight
type: class
memory_category: Instances
summary: |
A light source that emits illumination from a single point.
description: |
A PointLight is a light source that emits illumination from a single point.
Light is emitted spherically based on the `Class.PointLight.Range` of the
PointLight.
In order for a PointLight to provide illumination, it must be the direct child
of a `Class.BasePart` or `Class.Attachment` (the part or attachment itself
must be a descendant of the `Class.Workspace`).
If a PointLight is parented to a part, then the light will emanate from the
part's `Class.BasePart.Position`. If a PointLight is parented to an
attachment, then the light will emanate from the attachment's
`Class.Attachment.WorldPosition`.
For more light types, see the **see also** section.
## See Also
- `Class.SurfaceLight`
- `Class.SpotLight`
code_samples:
- pointlight
inherits:
- Light
descendants: []
tags: []
deprecation_message: ''
properties:
- name: PointLight.Range
summary: |
The size of the area that the PointLight will illuminate.
description: |
The size of the area that the PointLight will illuminate.
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
methods: []
events: []
callbacks: []