Package net.risingworld.api.objects.visuals

Class DarkTones

java.lang.Object

net.risingworld.api.objects.visuals.DarkTones

public final class DarkTones
extends Object

Post-processing effect: Dark tone adjustment, i.e adjustment of dark areas / shadows on the screen. Used in conjunction with a PostProcessing object.

See Also:

• Midtones
• Highlights

Constructor Summary

Constructors

Constructor	Description
DarkTones()

Method Summary

Modifier and Type	Method	Description
boolean	isOverridden()	Determines if the effect is set.
void	reset()	Resets the effect, so it is no longer active (and no longer overrides any game effects).
void	set(float intensity)	Sets the tonal range of shadows (dark areas) on the screen.
void	set(float r, float g, float b, float intensity)	Sets the tonal range of shadows (dark areas) on the screen.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DarkTones

public DarkTones()

Method Details

set

public void set(float intensity)

Sets the tonal range of shadows (dark areas) on the screen. To reset the value to the game default value, call reset()

Parameters:

intensity - shadow intensity, between -1 and +1. Default value is 0.

set

public void set(float r,
 float g,
 float b,
 float intensity)

Sets the tonal range of shadows (dark areas) on the screen. To reset the value to the game default value, call reset()

Parameters:

r - optional red color that is applied to the shadows. Default is 1.

g - optional green color that is applied to the shadows. Default is 1.

b - optional blue color that is applied to the shadows. Default is 1.

intensity - shadow intensity, between -1 and +1. Default value is 0.

reset

public void reset()

Resets the effect, so it is no longer active (and no longer overrides any game effects).

isOverridden

public boolean isOverridden()

Determines if the effect is set.

Returns:

true if this effect was set, false if not (or if it was reset).