Class Sunlight

Sunlight component

Export

Sunlight

Date

2024.8.12

Author

yisky

Hierarchy

Script
- Sunlight

Index

Constructors

Properties

_awoken _enabled entity isScript userData

Accessors

color direction enabled height intensity light scene

Constructors

constructor

new Sunlight(entity, options?): Sunlight
Parameters
- entity: Entity
- options: SunlightOptions = {}
Returns Sunlight
Overrides Script.constructor

Properties

`Protected`_awoken

_awoken: boolean

`Protected`_enabled

_enabled: boolean

`Readonly`entity

entity: Entity

`Readonly`isScript

isScript: boolean

Read-only flag to check if a given component is of type Script

Memberof

Script

userData

userData: {
[key: string]: any;
}

Component user data

Memberof

Component

Accessors

color

set color(value): void
Set sunlight color
Parameters
- value: ColorRepresentation
Returns void
Memberof
Sunlight

direction

set direction(value): void
Set sunlight direction
Parameters
- value: Vector3
Returns void
Memberof
Sunlight

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Memberof
Component

Inherited from Script.enabled
set enabled(value): void
Set whether the component is enabled.
Parameters
- value: boolean
Returns void
Memberof
Component

Inherited from Script.enabled

height

set height(value): void
Set sunlight height
Parameters
- value: number
Returns void
Memberof
Sunlight

intensity

set intensity(value): void
Set sunlight intensity
Parameters
- value: number
Returns void
Memberof
Sunlight

light

get light(): DirectionalLight
Get Three.js Directional

Returns DirectionalLight
Memberof
Sunlight

scene

get scene(): Scene
Scene own the component

Returns Scene
Memberof
Component

Inherited from Script.scene

Methods

`Protected`_onAwake

_onAwake(): void
Protected
Awake script

Returns void
Memberof
Script

Inherited from Script._onAwake

`Protected`_onDestroy

_onDestroy(): void
Protected
Destroy script

Returns void
Memberof
Script

Inherited from Script._onDestroy

`Protected`_onDisable

_onDisable(): void
Protected
Disable script

Returns void
Memberof
Script

Inherited from Script._onDisable

`Protected`_onEnable

_onEnable(): void
Protected
Enable script

Returns void
Memberof
Script

Inherited from Script._onEnable

desrtoy

desrtoy(): void
Destroy component

Returns void
Memberof
Component

Inherited from Script.desrtoy

dispose

dispose(): void
Clear subscribers

Returns void
Memberof
EventDispatcher

Inherited from Script.dispose

emit

emit(event): void
Emit event
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void
Memberof
EventDispatcher

Inherited from Script.emit

off

off(type, callback?): void
Unsubscribe a event, if the callback param is not defined, all subscribers of this type will be removed.
Parameters
- type: string
- Optionalcallback: SubscriberCallbackFn
  subscriber callback
Returns void
Memberof
EventDispatcher

Inherited from Script.off

on

on(type, callback, options?): void
Subscribe a event
Parameters
- type: string
  event type
- callback: SubscriberCallbackFn
  callback functions
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  }
  options
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from Script.on

onAfterCameraRender

onAfterCameraRender(camera): void
Script after camera render, called per camera.
Parameters
- camera: Camera
Returns void
Memberof
Script

Inherited from Script.onAfterCameraRender

onAwake

onAwake(): void
Awake script (Only call once when it's first enable)

Returns void
Memberof
Script

Inherited from Script.onAwake

onBeforeCameraRender

onBeforeCameraRender(camera): void
Before camera render callback
Parameters
- camera: Camera
Returns void
Memberof
Sunlight

Overrides Script.onBeforeCameraRender

once

once(type, callback, options?): void
Subscribe a event, just emit once
Parameters
- type: string
- callback: SubscriberCallbackFn
  subscriber callback
- Optionaloptions: {
  priority?: Priority;
  target?: any;
  }
  - Optionalpriority?: Priority
  - Optionaltarget?: any
Returns void
Memberof
EventDispatcher

Inherited from Script.once

onDestroy

onDestroy(): void
Destroy callback

Returns void
Memberof
Sunlight

Overrides Script.onDestroy

onDisable

onDisable(): void
Disable callback

Returns void
Memberof
Sunlight

Overrides Script.onDisable

onDisableInScene

onDisableInScene(): void
Disable the script when detach from scene

Returns void
Memberof
Script

Inherited from Script.onDisableInScene

onEnable

onEnable(): void
Enable callback

Returns void
Memberof
Sunlight

Overrides Script.onEnable

onLateUpdate

onLateUpdate(timeSinceLastFrame, totalTime): void
Script late update
Parameters
- timeSinceLastFrame: number
  time since last frame in seconds
- totalTime: number
  total time in seconds
Returns void
Memberof
Script

Inherited from Script.onLateUpdate

onPhysicsUpdate

onPhysicsUpdate(): void
Script physics update

Returns void
Memberof
Script

Inherited from Script.onPhysicsUpdate

onStart

onStart(): void
Start script (Call when the animation loop first start)

Returns void
Memberof
Script

Inherited from Script.onStart

onUpdate

onUpdate(timeSinceLastFrame, totalTime): void
Script update
Parameters
- timeSinceLastFrame: number
  time since last frame in seconds
- totalTime: number
  total time in seconds
Returns void
Memberof
Script

Inherited from Script.onUpdate