PcoWSkbVqDnWTu_dm2ix
We use cookies on this site to enhance your user experience
Collapse Sidebar

ColorCorrectionEffect

Show deprecated

ColorCorrectionEffect

Show deprecated

ColorCorrectionEffect is a post-processing effect that can be used to adjust several color-related properties at once: ColorCorrectionEffect/Saturation|Saturation, ColorCorrectionEffect/TintColor|TintColor, ColorCorrectionEffect/Brightness|Brightness and ColorCorrectionEffect/Contrast|Contrast. It is useful for fine-tuning the visual aesthetic of a world, or communicating status effects to the player such as flashing the world red upon taking damage, or going grayscale on character death. Like all PostEffect objects, objects of this kind should be parented to either the Lighting or the Workspace/CurrentCamera to work.

Multiple ColorCorrectionEffects can be applied at once, and they will compose their effects together. For example, if you use one with a yellow ColorCorrectionEffect/TintColor|TintColor and another with a blue tint, you will see green. Using more than one object can further strengthen the effects.

Example

No ColorCorrectionEffect (original):
No change
Increased Saturation (ColorCorrectionEffect/Saturation|Saturation = 1):
Increased saturation
No Saturation (ColorCorrectionEffect/Saturation|Saturation = -1):
No saturation
Sepia (No saturation plus ColorCorrectionEffect/TintColor|TintColor):
Sepia effect

Properties

float

Brightness

Determines by how much the brightness of pixel colors will be shifted

float

Contrast

Determines the change in separation between the dark and light colors

float

Saturation

Determines the change in intensity of colors

Color3

TintColor

Determines by how much the RGB channels of pixels are scaled

Inherited from PostEffect: Show Hide

bool

Enabled

Toggles whether or not the PostEffect is enabled.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Inherited from Instance: Show Hide

RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.