Skip to Content
EffectsScreen Effect

Screen Effect

An effect that resizes and positions a part to fill the camera’s viewport. This is used as a container for other effects that are meant to be displayed in front of the camera.

Summary

Attributes

Enabled : boolean

Determines whether the part is considered a screen effect.

PartDistance : number

The distance from the camera to the screen part in studs.

PartScale : Vector2

The scaling factor applied to the part’s size after it has been sized to the screen.

OffsetPosition : Vector3

The positional offset from the center of the camera’s view.

OffsetRotation : Vector3

The rotational offset in degrees applied to the screen part.

Attributes

Enabled

boolean

Determines whether the part is considered a screen effect.

PartDistance

number

The distance from the camera to the screen part. This can be used to control the perceived size and perspective of the screen effect.

PartScale

Vector2

The scaling factor applied to the part’s size after it has been sized to the screen.

OffsetPosition

Vector3

The positional offset applied to the part after it has been positioned in front of the camera.

OffsetRotation

Vector3

The rotational offset in degrees applied to the screen part after it has been positioned in front of the camera. The rotation is applied around the part’s center.

Last updated on