switchLight: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
back to [[Scripting_Reference#U|COMREF]]
back to [[Scripting_Reference#S|COMREF]]


<h2 style="color:#000066">''lamp '''''switchLight '''''mode''</h2>
<h2 style="color:#000066">'''''lamp'' switchLight ''mode'''''</h2>


'''Operand types:'''
'''Operand types:'''


lamp: [[Object]]
'''lamp:''' [[Object]]


mode: [[String]]
'''mode:''' [[String]]


'''Type of returned value:'''
'''Type of returned value:'''


Nothing
[[Nothing]]


'''Description:'''
'''Description:'''


Controls lampost mode.
Controls lampost '''mode'''.


Mode may be:
'''Mode''' may be:


    * "ON"
* '''"ON"'''
    * "OFF"
* '''"OFF"'''
    * "AUTO" ( Lampost is on only during nighttime)
* '''"AUTO"''' ( Lampost is on only during nighttime)
 
'''"AUTO"''' is default.


"AUTO" is default.


'''Examples:'''
'''Examples:'''


(object 12345) '''switchLight''' "off"
([[object]] 12345) '''switchLight''' '''"off"'''
 
[[nearestObject]] [[[player]], "Streetlamp"] '''switchLight''' '''"OFF"'''


nearestObject [player, "Streetlamp"] '''switchLight''' "OFF"


'''Comments'''
'''Comments'''


Use [[lightIsOn]] to check the status of a lamppost.
Use [[lightIsOn]] to check the status of a lamppost.

Revision as of 13:28, 17 April 2006

back to COMREF

lamp switchLight mode

Operand types:

lamp: Object

mode: String

Type of returned value:

Nothing

Description:

Controls lampost mode.

Mode may be:

  • "ON"
  • "OFF"
  • "AUTO" ( Lampost is on only during nighttime)

"AUTO" is default.


Examples:

(object 12345) switchLight "off"

nearestObject [[[player]], "Streetlamp"] switchLight "OFF"


Comments

Use lightIsOn to check the status of a lamppost.