Sansar Docs
  • 🚀Welcome to Sansar
  • 📚GLOSSARY
  • 🎏Patch Notes
  • 😇Work in Progress
  • ⚠️Creative Commons License
  • Support
    • General Troubleshooting
      • General FAQ
      • The Sansar Cache
      • The Sansar Log
    • Contact Support
  • Sansar Basics
    • Installation And Compatibility
      • Installing Sansar
      • System Requirements
      • Sansar Compatibility FAQ
      • Sansar on Mac
      • Body Tracking Vive
      • Configuring Firewalls
    • Account Management
      • Account Set Up
      • Avatar Name and ID
      • Adding Payment Method
      • Discord FAQ
      • Steam Integration
      • Subscription FAQ
    • Controls
      • Avatar Hand Gestures in VR
      • FreeCam and CineCam
      • Game Controller Buttons
      • HTC VIVE controls
      • Keyboard Shortcuts for Editing a Scene
      • Keyboard Shortcuts for Styling Your Avatar
      • Keyboard Shortcuts for Visiting an Experience
      • Mouselook Mode
      • Oculus Rift Controls
      • Vive Index Controls
    • Settings
      • General Settings
    • VR Settings
      • VR Settings Menu
      • Calibrating Height in VR
  • Exploring in Sansar
    • Navigate and Explore
      • The Codex
      • Instances
      • Interactive objects
      • The Main Menu
      • The Nexus
      • Portals
      • Quests
      • Quick Start: Exploring in Sansar
    • Socialize And Connect
      • Chat Panel
      • Experience Points, Levels, and Titles.
      • Finding People in Sansar
      • Identifying Interacting With Avatars
      • The People panel
      • User profiles
    • Attending events
      • Deploying Unpublished Event to Event World
      • Adding Events to Your Calendar
      • Attending Events in Sansar
      • Avatar Broadcasting FAQ
      • Creating Your Own Events
      • Redemption Codes
      • Tipping
    • Share Content
      • Streaming Sansar
      • Taking a photo
  • Avatar Creation
    • Avatar Basics
      • Avatar 2.0 FAQ
      • Customizing Your Avatar
      • Avatar Emotes
      • The Avatar Editor
    • Dressing The Avatar
      • Fitting Designer Clothing to your Avatar
      • Setting Custom Emotes
      • Wearing Accessories
      • Wearing Rigged Clothing
    • Managing Avatar Items
      • Importing Avatar-Related Items
      • Editing an inventory item's name
      • Editing an inventory item's image
      • Deleting avatar looks from your inventory
      • Importing a custom emote animation
      • Managing your avatar looks inventory items
    • Avatar Resources
      • Avatar Reference Files
      • Blender - Avatar files
      • Blender - Using Decimate Tool
      • Exporting Custom Avatars From Blender
      • Sansar Skeleton Skinning Details
      • Using Animation Skeleton
  • Creating In Sansar
    • Importing Things to Sansar
      • Supported file types
      • AABB Bounding Box and Item Restrictions
      • Importing Audio
      • Importing a Custom Avatar
      • Importing World Items
      • Importing Collision Volumes
      • Importing Accessories
      • Importing Clothing
      • Importing Emotes
      • Importing Hair
      • Importing Custom Scripts
      • Importing a Skybox
      • Troubleshooting Import Errors
    • Shaders and Materials
      • Shaders Information
      • Materials Information
      • VAT Shader Guides
        • VAT Shader Basics
        • VAT Technical Info
      • Displacement Guides
        • Simple Displacement
        • Advanced Displacement
    • Marvelous Designer Info
      • Marvelous Designer Integration
      • Marvelous Designer Creator Resources
      • Marvelous Import and Export
      • MD Limitations
    • Shader Scripting
    • Materials editing and shaders
    • Creator Tools
      • Creating a World
      • Creating Quests
      • Diagnostics Toolbar
      • Importing Items to Sansar
      • My Worlds Panel
    • Managing Worlds
      • Quick start: Creating experiences in Sansar
      • Deleting an experience or scene
      • Deploying a new scene to an existing experience
      • Editing a scene
      • Experience memos
      • Linking A Scene To A World
      • Managing your scenes and worlds
      • Moderation Tools for World Owners
      • Publishing Options for Your Experiences
      • Renaming a scene
      • Saving and Building A Scene
      • Sharing Your Experiences
      • Visiting your own experience
    • Part Of The World Editor
      • Object Stats Toolbar
      • Object Components
      • Parenting objects
      • Scene Item Inventory
      • Scene Objects Panel
      • Collision Volumes
      • Scene Settings
      • System objects
      • Object Motion Types
    • Working With Scripts
      • Working With Scripts
      • Working With Trigger Volume
      • Referencing Scene Components
      • Intro to Scripting in Sansar
      • Using the Script Console
      • Setting Script Parameters
      • Adding Scripts to an Object
      • Configuring Teleport Scripts
      • Simple Script User Guide
    • Working With Audio and Video
      • Working With Audio
      • Creating Media surface
      • Streaming Web Audio
      • Audio Emitter
      • Sansar Audio FAQ
      • Using Media Streams
      • Ambisonic Sounds
      • High Quality Spacial Audio
      • Audio Resource - Room Tones
      • Previewing Audio and Video in a Scene
      • Using Audio Materials
    • Working With Lights
      • Working With Lights
      • Light Types
      • Global Illumination
  • Sansar Store
    • Using the Sansar Store
      • The Sansar Store
      • Buying Items From The Store
      • Redelivering Lost Purchases
    • Buying and Selling Sansar Dollars
      • Gifting Sansar Dollars
      • Buying Sansar Dollars
      • Converting Sansar Dollars
      • Processing US Dollar Credit
    • Selling Your Content
      • Hidden Store Listings
      • Selling Items in Sansar Store
      • Selling Items in an Experience
      • Allowing Resale Of Items
      • Buyers Permissions
  • Guidelines and Moderation
    • Guidelines and Policies
      • Terms of service
      • Sansar's Discord Server Rules
      • Community Standards
      • Content Guidelines
      • World Publishing Guidelines
      • Store Listing Guidelines
      • Store Banner Guidelines
      • Event Guidelines
      • Privacy Policy
      • Sansar Freeware License Agreement
      • Intellectual Property Infringement Notification
      • Cookie Policy
    • Moderation and Reporting
      • Abuse and Griefing
      • Blocking Avatars
      • Muting Avatars
      • Reporting abuse
      • Reporting issues and bugs
      • Security issues
  • Script API Docs
    • General Information
      • External Script Repository's
      • Sansar Script API
      • Script API Updates
      • Restricted API's
    • Example Scripts
      • Example Scripts in Sansar
      • Cannonball
      • Follow The Path
      • Random Movement
      • Reflective Detector
      • Simple Script
      • Sound Randomizer
      • Stats Example
      • Teleport Hotkeys
      • Visitor Tracker
      • Mover Examples
    • Sansar Namespace
      • Namespace
      • Color
      • Mathf
      • Quarterion
      • Vector
      • Vector Extensions
    • Sansar.Script Namespace
      • AddEntryAttribute
      • CancelData
      • ComponentID
      • CoroutineException
      • Default Attributes
      • Editor Visible Attribute
      • Entries Attribute
      • Event Data
      • ICoroutine
      • IEvent Subscription
      • Instance Interface
      • Locked Attribute
      • Log
      • MaxEntriesAttribute
      • Memory
      • MinEntriesAttribute
      • NonReflectiveAttribute
      • ObjectID
      • OperationCompleteEvent
      • RangeAttribute
      • Reflective
      • Script.Base
      • Script Event Data
      • Script Handle
      • ScriptID
      • SessionID
      • Simple Script Event Data
      • ThrottleException
      • Timer
      • Tooltip Attribute
    • MetaData Namespace
      • Assembly MetaData
      • Script MetaData
    • Sansar Script Testing Namespace
      • Assertion Failure Exception
      • Assertions
    • Sansar Utility Namespace
      • GenericEnumerable <T>
      • GenericEnumerable<T>.GetItem
      • JSON Serialization Data
      • JSON Serialization Data 1
      • JSON Serializer
      • JSON Serializer Options
    • Sansar Simulation Namespace
      • Agent Info
      • Animation
      • Audio Component
      • Camera Control Mode
      • Character Tracker
      • Chat
      • Client
      • Cluster
      • Command Action and Data
      • Component Type
      • Control Point Type
      • Held Object
      • HTTP
      • Interaction
      • Light
      • Media Action
      • Mesh Component
      • Modal Dialogue
      • Move Mode and Mover
      • Objective
      • PlayHandle
      • PlaySettings
      • PlayStatus
      • Quest
      • RayCastHit
      • Rigid Body
      • Scene
      • Scene Public
      • Simple Script
      • Sit Event Type
      • Sit Object Data
      • Sound Resource
      • Stream Channel
      • Tutorial Hint
      • UI
      • User Data
Powered by GitBook
On this page
  • LightComponent Class
  • Syntax
  • Member Details
  • LightType Enum
  • Syntax
  • Remarks
  • Members
  • Requirements
  1. Script API Docs
  2. Sansar Simulation Namespace

Light

LightComponent Class

The LightComponent handles interactions with lights.

Syntax

Member Details

ComponentId Property

Retrieves the component id for this LightComponent.

Syntax

Value

The id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


ComponentType Field

Syntax

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetAngle Method

Retrieves the cone angle of this LightComponent.

Syntax

Returns

The angle in degrees.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetAngularFalloff Method

Retrieves the angular falloff of this LightComponent.

Syntax

Returns

The angular falloff.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetCastsShadows Method

Retrieves whether this LightComponent casts shadows.

Syntax

Returns

The shadow cast state.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetNearClip Method

Retrieves the near clip distance of this LightComponent.

Syntax

Returns

The near clip distance.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetNormalizedColor Method

Retrieves the normalized color of this LightComponent.

Syntax

Returns

The normalized color.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetRange Method

Retrieves the current range of this LightComponent.

Syntax

Returns

The range.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetRelativeIntensity Method

Retrieves the intensity of this LightComponent based on its normalized color.

Syntax

Returns

The intensity based on a normalized color.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


GetShadowPriority Method

Retrieves the shadow priority of this LightComponent.

Syntax

Returns

The shadow priority.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


IsScriptable Property

The scriptable flag for this LightComponent.

Syntax

Value

Whether or not this light can have properties changed by script.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


LightType Property

The light type for this LightComponent.

Syntax

Value

Light type enum for the light component.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


Name Property

This LightComponent name, as specified in the editor.

Syntax

Value

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetAngle Method

Sets the cone angle for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

angle

The angle in degrees, 1 to 160.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetAngle Method

Sets the cone angle for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

angle

The angle in degrees, 1 to 160.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetAngle Method

Sets the cone angle for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

angle

The angle in degrees, 1 to 160.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetAngularFalloff Method

Sets the angular falloff for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

angularFalloff

The angular falloff, 0.01 to 1.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetAngularFalloff Method

Sets the angular falloff for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

angularFalloff

The angular falloff, 0.01 to 1.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetAngularFalloff Method

Sets the angular falloff for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

angularFalloff

The angular falloff, 0.01 to 1.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetCastsShadows Method

Sets whether shadows are cast from this LightComponent of type LightType.SpotLight.

Syntax

Parameters

castsShadows

True to cast shadows.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetCastsShadows Method

Sets whether shadows are cast from this LightComponent of type LightType.SpotLight.

Syntax

Parameters

castsShadows

True to cast shadows.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetCastsShadows Method

Sets whether shadows are cast from this LightComponent of type LightType.SpotLight.

Syntax

Parameters

castsShadows

True to cast shadows.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetColorAndIntensity Method

Sets the color for this LightComponent.

Syntax

Parameters

color

The color.

intensity

The intensity, 0 to 100.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetColorAndIntensity Method

Sets the color for this LightComponent.

Syntax

Parameters

color

The color.

intensity

The intensity, 0 to 100.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetColorAndIntensity Method

Sets the color for this LightComponent.

Syntax

Parameters

color

The color.

intensity

The intensity, 0 to 100.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetNearClip Method

Sets the near clip plane distance for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

nearClip

The near clip distance, 0 to 500.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetNearClip Method

Sets the near clip plane distance for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

nearClip

The near clip distance, 0 to 500.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetNearClip Method

Sets the near clip plane distance for this LightComponent of type LightType.SpotLight.

Syntax

Parameters

nearClip

The near clip distance, 0 to 500.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetRange Method

Sets the range for this LightComponent.

Syntax

Parameters

range

The range, 1 to 500.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetRange Method

Sets the range for this LightComponent.

Syntax

Parameters

range

The range, 1 to 500.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetRange Method

Sets the range for this LightComponent.

Syntax

Parameters

range

The range, 1 to 500.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetShadowPriority Method

Sets the shadow priority of this LightComponent of type LightType.SpotLight.

Syntax

Parameters

shadowPriority

Shadow priority.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetShadowPriority Method

Sets the shadow priority of this LightComponent of type LightType.SpotLight.

Syntax

Parameters

shadowPriority

Shadow priority.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


SetShadowPriority Method

Sets the shadow priority of this LightComponent of type LightType.SpotLight.

Syntax

Parameters

shadowPriority

Shadow priority.

handler

Handler to be called when the event completes.

Returns

The return value is an internal event id.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


ToString Method

A string representation of this object.

Syntax

Returns

A string representation of this object.

Remarks

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0



LightType Enum

Enumeration for the different types of lights

Syntax

[Sansar.Script.Interface] public enum LightType

Remarks

Members

Member Name
Description

Directional

Lights that illuminate in a single direction across the entire scene.

Point

Lights that illuminate from a point outward in all directions.

Spot

Lights that illuminate from a point outward in a cone shape.

Requirements

Namespace: Sansar.Simulation Assembly: Sansar.Simulation (in Sansar.Simulation.dll) Assembly Versions: 1.1.0.0


PreviousInteractionNextMedia Action

Last updated 6 months ago

[Sansar.Script.Interface] public GetAngle ()

[Sansar.Script.Interface] public GetAngularFalloff ()

[Sansar.Script.Interface] public GetCastsShadows ()

[Sansar.Script.Interface] public GetNearClip ()

[Sansar.Script.Interface] public GetNormalizedColor ()

[Sansar.Script.Interface] public GetRange ()

[Sansar.Script.Interface] public GetRelativeIntensity ()

[Sansar.Script.Interface] public GetShadowPriority ()

[get: Sansar.Script.Interface] public IsScriptable { get; }

[get: Sansar.Script.Interface] public LightType { get; }

[get: Sansar.Script.Interface] public Name { get; }

[Sansar.Script.Interface] public SetAngle ( angle)

[Sansar.Script.Interface] public SetAngularFalloff ( angularFalloff)

[Sansar.Script.Interface] public SetCastsShadows ( castsShadows)

This method only affects spot lights. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

This method only affects spot lights. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

This method only affects spot lights. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

[Sansar.Script.Interface] public SetColorAndIntensity ( color, intensity)

The intensity is multiplied by the color and then applied to the light. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

The intensity is multiplied by the color and then applied to the light. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

The intensity is multiplied by the color and then applied to the light. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

[Sansar.Script.Interface] public SetNearClip ( nearClip)

[Sansar.Script.Interface] public SetRange ( range)

[Sansar.Script.Interface] public SetShadowPriority ( shadowPriority)

Set this to zero to turn off shadows. This method only affects spot lights. The renderer prioritizes shadows cast from higher priority lights first. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

Set this to zero to turn off shadows. This method only affects spot lights. The renderer prioritizes shadows cast from higher priority lights first. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

Set this to zero to turn off shadows. This method only affects spot lights. The renderer prioritizes shadows cast from higher priority lights first. This asynchronous method queues the write then returns. To block until the write has occurred, pass this method to while in a coroutine.

[Sansar.Script.Interface] public override ToString ()

float
float
bool
float
Sansar.Color
float
float
uint
bool
LightType
string
void
float
void
float
void
bool
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
void
Sansar.Color
float
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
void
float
void
float
void
uint
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
Sansar.Script.ScriptBase.WaitFor
string