Description
Supported Script Types:
- Interface Scripts
- Client Entity Scripts
- Avatar Scripts
Render
API enables you to configure the graphics engine.Properties
Name | Type | Summary |
---|---|---|
renderMethod | Render.RenderMethod |
The render method being used. |
shadowsEnabled | boolean |
|
ambientOcclusionEnabled | boolean |
|
antialiasingMethod | Render.AntialiasingMethod |
The anti-aliasing method being used. |
viewportResolutionScale | number |
The view port resolution scale, |
nametagsEnabled | boolean |
|
nametagsShowSelf | boolean |
|
maximumTextureMemory | number |
The maximum texture memory in MB. |
farClip | number |
The far clip distance. |
Methods
Name | Return Value | Summary |
---|---|---|
getAmbientOcclusionEnabled
|
boolean |
Gets whether or not ambient occlusion is enabled. |
getAntialiasingMethod
|
Render.AntialiasingMethod |
Gets the anti-aliasing method being used. |
getAntialiasingMethodNames
|
Array.<string> |
Gets the names of the possible anti-aliasing methods, per Render.AntialiasingMethod. |
getConfig
|
object |
Gets the configuration for a rendering job by name. Warning: For internal, debugging purposes. Subject to change. |
getFarClip
|
number |
Gets the far clip distance. |
getFieldOfView
|
number |
Gets the field of view in degrees. |
getMaximumTextureMemory
|
number |
Gets the maxmium texture memory in MB. |
getNametagsEnabled
|
boolean |
Gets whether nametags are enabled. |
getNametagsShowSelf
|
boolean |
Gets whether your nametag should appear above you. |
getRenderMethod
|
Render.RenderMethod |
Gets the render method being used. |
getRenderMethodNames
|
Array.<string> |
Gets the names of the possible render methods, per Render.RenderMethod. |
getShadowsEnabled
|
boolean |
Gets whether or not shadows are enabled. |
getViewportResolutionScale
|
number |
Gets the view port resolution scale. |
setAmbientOcclusionEnabled
|
None |
Sets whether or not ambient occlusion is enabled. |
setAntialiasingMethod
|
None |
Sets the anti-aliasing method to use. |
setFarClip
|
None |
Sets the far clip distance. |
setFieldOfView
|
None |
Sets the field of view in degrees. |
setMaximumTextureMemory
|
None |
Sets the maxmium texture memory in MB. |
setNametagsEnabled
|
None |
Sets whether nametags are enabled. |
setNametagsShowSelf
|
None |
Sets whether your nametag should appear above you. |
setRenderMethod
|
None |
Sets the render method to use. |
setShadowsEnabled
|
None |
Sets whether or not shadows are enabled. |
setViewportResolutionScale
|
None |
Sets the view port resolution scale. |
Signals
Name | Summary |
---|---|
settingsChanged
|
Triggered when one of the |
Type Definitions
AntialiasingMethod Type: number |
||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
The anti-aliasing method is specified by the following values:
|
RenderMethod Type: number |
|||||||||
---|---|---|---|---|---|---|---|---|---|
The rendering method is specified by the following values:
|
Method Details
(static) getAmbientOcclusionEnabled( ) → {boolean}
Returns: true if ambient occlusion is enabled, false if it's disabled.
|
---|
Gets whether or not ambient occlusion is enabled. |
(static) getAntialiasingMethod( ) → {Render.AntialiasingMethod}
Returns: The anti-aliasing method being used. |
---|
Gets the anti-aliasing method being used. ExampleReport the current anti-aliasing method.
|
(static) getAntialiasingMethodNames( ) → {Array.<string>}
Returns: The names of the possible anti-aliasing methods. |
---|
Gets the names of the possible anti-aliasing methods, per Render.AntialiasingMethod. ExampleReport the names of the possible anti-aliasing methods.
|
(static) getConfig( name ) → {object}
Returns: The configuration for the rendering job. |
||||||
---|---|---|---|---|---|---|
Gets the configuration for a rendering job by name. Warning: For internal, debugging purposes. Subject to change. Parameters
|
(static) getFarClip( ) → {number}
Returns: number |
---|
Gets the far clip distance. |
(static) getFieldOfView( ) → {number}
Returns: number |
---|
Gets the field of view in degrees. |
(static) getMaximumTextureMemory( ) → {number}
Returns: number |
---|
Gets the maxmium texture memory in MB. |
Returns: true if nametags are enabled, false if they're disabled.
|
---|
Gets whether nametags are enabled. |
Returns: true if your nametag should appear above you, false if not.
|
---|
Gets whether your nametag should appear above you. |
(static) getRenderMethod( ) → {Render.RenderMethod}
Returns: The render method being used. |
---|
Gets the render method being used. ExampleReport the current render method.
|
(static) getRenderMethodNames( ) → {Array.<string>}
Returns: The names of the possible render methods. |
---|
Gets the names of the possible render methods, per Render.RenderMethod. ExampleReport the names of the possible render methods.
|
(static) getShadowsEnabled( ) → {boolean}
Returns: true if shadows are enabled, false if they're disabled.
|
---|
Gets whether or not shadows are enabled. |
(static) getViewportResolutionScale( ) → {number}
Returns: The view port resolution scale, > 0.0 .
|
---|
Gets the view port resolution scale. |
(static) setAmbientOcclusionEnabled( enabled ) | ||||||
---|---|---|---|---|---|---|
Sets whether or not ambient occlusion is enabled. Parameters
|
(static) setAntialiasingMethod( antialiasingMethod ) | ||||||
---|---|---|---|---|---|---|
Sets the anti-aliasing method to use. Parameters
|
(static) setFarClip( farClip ) | ||||||
---|---|---|---|---|---|---|
Sets the far clip distance. Parameters
|
(static) setFieldOfView( fieldOfView ) | ||||||
---|---|---|---|---|---|---|
Sets the field of view in degrees. Parameters
|
(static) setMaximumTextureMemory( maximumTextureMemory ) | ||||||
---|---|---|---|---|---|---|
Sets the maxmium texture memory in MB. Parameters
|
Sets whether nametags are enabled. Parameters
|
Sets whether your nametag should appear above you. Parameters
|
(static) setRenderMethod( renderMethod ) | ||||||
---|---|---|---|---|---|---|
Sets the render method to use. Parameters
|
(static) setShadowsEnabled( enabled ) | ||||||
---|---|---|---|---|---|---|
Sets whether or not shadows are enabled. Parameters
|
(static) setViewportResolutionScale( resolutionScale ) | ||||||
---|---|---|---|---|---|---|
Sets the view port resolution scale. Parameters
|
Signal Details
settingsChanged(
)
Returns: Signal |
---|
Triggered when one of the ExampleReport when a render setting changes.
|