<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head>
<script type="text/javascript" language="JavaScript">
function reDo() {
if (innerWidth != origWidth || innerHeight != origHeight)
location.reload();
}
if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
origWidth = innerWidth;
origHeight = innerHeight;
onresize = reDo;
}
onerror = null;
</script>
<style type="text/css">
< !-- div.WebHelpPopupMenu {
position: absolute;
left: 0px;
top: 0px;
z-index: 4;
visibility: hidden;
}
p.WebHelpNavBar {
text-align: right;
}
-->
</style>
<script type="text/javascript">
gRootRelPath = "../../../..";
gCommonRootRelPath = "../../../..";
gTopicId = "9.2.5.9.0_7";
<script type="text/javascript" src="../../../../template/scripts/rh.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/common.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/topic.min.js"></script>
<script type="text/javascript" src="../../../../template/scripts/topicwidgets.min.js"></script>
<script type="text/javascript" src="../../../../whxdata/projectsettings.js"></script>
<link rel="stylesheet" type="text/css" href="../../../../template/styles/topic.min.css"/>
<link rel="stylesheet" type="text/css" href="../../../../template/Charcoal_Grey/topicheader.css"/>
<meta name="topic-status" content="Draft"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>draw_light_get</title>
<meta name="generator" content="Adobe RoboHelp 2019"/>
<link rel="stylesheet" href="../../../../assets/css/default.css" type="text/css"/>
<meta name="rh-authors" content="Mark Alexander"/>
<meta name="topic-comment" content="Reference page for draw_light_get"/>
<meta name="rh-index-keywords" content="draw_light_get"/>
<meta name="search-keywords" content="draw_light_get"/>
</head>
<body>
<div class="topic-header rh-hide" id="rh-topic-header" onclick="rh._.goToFullLayout()">
<div class="logo">
</div>
<div class="nav">
<div class="title" title="draw_light_get">
<span>draw_light_get</span>
</div>
<div class="gotohome" title="Click here to see this page in full context">
<span>Click here to see this page in full context</span>
</div>
</div>
</div>
<div class="topic-header-shadow rh-hide" id="rh-topic-header-shadow"></div>
<h1>draw_light_get</h1>
<p>This function will get the specified light parameters as an array with the following 6 elements -</p>
<ul class="colour">
<li>[0] = enabled / disabled (<tt>true</tt> / <tt>false</tt>)</li>
<li>[1] = light type (see constants below)</li>
<li>[2] = x position</li>
<li>[3] = y position</li>
<li>[4] = z position</li>
<li>[5] = light radius (only for point lights, will be 0 for directional)</li>
<li>[6] = light colour (a real)</li>
</ul>
<p>The light type can be one of the following two constants:</p>
<p> </p>
<table>
<tbody>
<tr>
<th>Constant</th>
<th>Description</th>
</tr>
<tr>
<td>lighttype_dir</td>
<td>The light is a directional light</td>
</tr>
<tr>
<td>lighttype_point</td>
<td>The light is a point light</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Syntax:</h4>
<p class="code">draw_light_get(ind);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>ind</td>
<td>The index number of the light (from 0 to 7)</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">Real</p>
<p> </p>
<h4>Example:</h4>
<p class="code">light_a = draw_light_get(1);<br/> if light_a[5] < 200<br/> {
<br/> light_a[5] += 5;<br/> draw_light_define_point(1, 200, 123, 50, light_a[5], c_white);<br/> }
</p>
<p>The above code will get the values used to define the light indexed as "1", then check the radius and if it is less than 200 it will be increased and the light radius set to the new value.</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="Lighting.htm">Lighting</a></div>
<div style="float:right">Next: <a href="draw_get_lighting.htm">draw_get_lighting</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>