OutlineSettings
ClassUsed in Text's outlineSettings property.
- Available on all platforms
Used in Text's outlineSettings property.
Configures how text outlining will appear on a Text component.
Index
Example
// @input Component.Text textComponent
var outlineSettings = script.textComponent.outlineSettings;
outlineSettings.enabled = true;
outlineSettings.size = 0.25;
outlineSettings.fill.color = new vec4(0, 0, 1, 1);
Extends
Properties
enabled
enabled:
boolean
Whether outline is enabled on the Text.
Default Value
false
fill
fill:
TextFill
Settings for how the outline is drawn.
size
size:
number
The strength of the outline effect, ranging from 0.0 (no outline) to 1.0 (very strong outline).
Default Value
0.25
Methods
getTypeName()
staticgetTypeName():TypeName<OutlineSettings>
Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().
Returns
TypeName<OutlineSettings>
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object matches or derives from the passed in type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean