253 lines
13 KiB
HTML
253 lines
13 KiB
HTML
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|||
|
|
<html>
|
|||
|
|
<head>
|
|||
|
|
<title><EFBFBD>berTools Game Development Kit</title>
|
|||
|
|
<link rel="stylesheet" href="style.css">
|
|||
|
|
<script type="text/javascript">
|
|||
|
|
|
|||
|
|
/***********************************************
|
|||
|
|
* Switch Menu script- by Martial B of http://getElementById.com/
|
|||
|
|
* Modified by Dynamic Drive for format & NS4/IE4 compatibility
|
|||
|
|
* Visit http://www.dynamicdrive.com/ for full source code
|
|||
|
|
***********************************************/
|
|||
|
|
|
|||
|
|
if (document.getElementById){ //DynamicDrive.com change
|
|||
|
|
document.write('<style type="text/css">\n')
|
|||
|
|
document.write('.submenu{display: none;}\n')
|
|||
|
|
document.write('</style>\n')
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
function SwitchMenu(obj){
|
|||
|
|
if(document.getElementById){
|
|||
|
|
var el = document.getElementById(obj);
|
|||
|
|
var ar = document.getElementById("masterdiv").getElementsByTagName("span"); //DynamicDrive.com change
|
|||
|
|
if(el.style.display != "block"){ //DynamicDrive.com change
|
|||
|
|
for (var i=0; i<ar.length; i++){
|
|||
|
|
if (ar[i].className=="submenu") //DynamicDrive.com change
|
|||
|
|
ar[i].style.display = "none";
|
|||
|
|
}
|
|||
|
|
el.style.display = "block";
|
|||
|
|
}else{
|
|||
|
|
el.style.display = "none";
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
</script>
|
|||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body>
|
|||
|
|
<a name="top"></a>
|
|||
|
|
<table width="702" border="0" align="center" cellpadding="0" cellspacing="0">
|
|||
|
|
<tr>
|
|||
|
|
<td colspan="3"><img src="../images/header.jpg" width="702" height="101" border="0"></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width=158 valign="top"><table border="0" cellspacing="0" cellpadding="0">
|
|||
|
|
<tr>
|
|||
|
|
<td valign="top" class="menu">
|
|||
|
|
<!-- Keep all menus within masterdiv-->
|
|||
|
|
<div id="masterdiv">
|
|||
|
|
<img src="../images/navigation.jpg" width="158" height="27"><br>
|
|||
|
|
UberTools GDK
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub0')">» Introduction & Contents</div>
|
|||
|
|
<span class="submenu" id="sub0">
|
|||
|
|
<a href="../start.html">Introduction</a><br>
|
|||
|
|
<a href="../start.html#2">Utilities</a><br>
|
|||
|
|
<a href="../start.html#3">Source Files</a><br>
|
|||
|
|
</span>
|
|||
|
|
<br>Level Design<br>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub1')">» Setting Up UberRadiant</div>
|
|||
|
|
<span class="submenu" id="sub1">
|
|||
|
|
<a href="radiant_setup.html">That Scary Error Msg</a><br>
|
|||
|
|
<a href="radiant_setup.html#2">General Tab</a><br>
|
|||
|
|
<a href="radiant_setup.html#3">Display Tab</a><br>
|
|||
|
|
<a href="radiant_setup.html#4">User Interface Tab</a><br>
|
|||
|
|
<a href="radiant_setup.html#5">Keyboard Shortcuts Tab</a><br>
|
|||
|
|
<a href="radiant_setup.html#6">Colors Tab</a><br>
|
|||
|
|
<a href="radiant_setup.html#7">Game / Paths Tab</a><br>
|
|||
|
|
</span>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub2')">» Building Your First Room</div>
|
|||
|
|
<span class="submenu" id="sub2">
|
|||
|
|
<a href="radiant_firstroom.html">Editor Interface Basics</a><br>
|
|||
|
|
<a href="radiant_firstroom.html#2">Choosing Your Textures</a><br>
|
|||
|
|
<a href="radiant_firstroom.html#3">Building The Room</a><br>
|
|||
|
|
<a href="radiant_firstroom.html#4">Adding a Light</a><br>
|
|||
|
|
<a href="radiant_firstroom.html#5">Adding a Player Start</a><br>
|
|||
|
|
<a href="radiant_firstroom.html#6">Compiling Your Level</a><br>
|
|||
|
|
<a href="radiant_firstroom.html#7">Viewing the Level</a><br>
|
|||
|
|
</span>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub3')">» Constructing Terrain</div>
|
|||
|
|
<span class="submenu" id="sub3">
|
|||
|
|
<a href="radiant_terrain.html">Setting up the Tools</a><br>
|
|||
|
|
<a href="radiant_terrain.html#2">Creating Terrain</a><br>
|
|||
|
|
<a href="radiant_terrain.html#3">Modifying the Textures</a><br>
|
|||
|
|
<a href="radiant_terrain.html#4">Adding More Terrain</a><br>
|
|||
|
|
</span>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub4')">» Additional Reference</div>
|
|||
|
|
<span class="submenu" id="sub4">
|
|||
|
|
<a href="ldesign_lighting.html">Lighting System</a><br>
|
|||
|
|
<a href="ldesign_terrain.html">Terrain Texture Blending</a><br>
|
|||
|
|
</span>
|
|||
|
|
<br>Scripting<br>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub5')">» Scripting Tutorials</div>
|
|||
|
|
<span class="submenu" id="sub5">
|
|||
|
|
<a href="scripting_syntax.html">Scripting Syntax</a><br>
|
|||
|
|
<a href="scripting_waves.html">Spawning Waves</a><br>
|
|||
|
|
<a href="scripting_flying.html">Creating Flying Creatures</a><br>
|
|||
|
|
<a href="scripting_tripwires.html">Setting Up Tripwires</a><br>
|
|||
|
|
</span>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub6')">» Global Script Synopsis</div>
|
|||
|
|
<span class="submenu" id="sub6">
|
|||
|
|
<a href="scripting_globalscripts.html">Introduction</a><br>
|
|||
|
|
<a href="scripting_globalscripts_accelmove.html">global_accelerated</a><br>
|
|||
|
|
<a href="scripting_globalscripts_accelmove.html">Movement.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_archetype.html">global_archetype.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_array.html">global_array.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_cinefx.html">global_cinematicFX.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_common.html">global_common.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_debug.html">global_debugUtils.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_flyin.html">global_flyin.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_math.html">global_math.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_ploadout.html">global_playerLoadout.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_soundpan.html">global_soundPan.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_spawnwave.html">global_spawnWave.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_transport.html">global_Transport.scr</a><br>
|
|||
|
|
<a href="scripting_globalscripts_tripwire.html">global_tripwire.scr</a><br>
|
|||
|
|
</span>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub7')">» Classes Reference</div>
|
|||
|
|
<span class="submenu" id="sub7">
|
|||
|
|
<a href="allclasses_g.html">Game Module</a><br>
|
|||
|
|
<a href="allclasses_cl.html">Client Module</a><br>
|
|||
|
|
<a href="allclasses_cg.html">Client Game Module</a><br>
|
|||
|
|
</span>
|
|||
|
|
<br>Older Documentation<br>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub8')">» Heavy Metal FAKK2</div>
|
|||
|
|
<span class="submenu" id="sub8">
|
|||
|
|
<a href="fakk2_camera.html">Camera Documentation</a><br>
|
|||
|
|
<a href="fakk2_clientsidecmds.html">Client Side Commands</a><br>
|
|||
|
|
<a href="fakk2_gui.html">GUI Documentation</a><br>
|
|||
|
|
<a href="fakk2_ingameutils.html">In-Game Utilities</a><br>
|
|||
|
|
<a href="fakk2_max2skl.html">MAX2SKL Reference</a><br>
|
|||
|
|
<a href="fakk2_shadermanual.html">Shader Manual</a><br>
|
|||
|
|
<a href="fakk2_soundsystem.html">Sound System</a><br>
|
|||
|
|
<a href="fakk2_tiki.html">TIKI Model System</a><br>
|
|||
|
|
</span>
|
|||
|
|
<br>Other<br>
|
|||
|
|
<div class="menutitle" onclick="SwitchMenu('sub9')">» Web Links & Credits</div>
|
|||
|
|
<span class="submenu" id="sub9">
|
|||
|
|
<a href="other_links.html">Web Links</a><br>
|
|||
|
|
<a href="other_credits.html">Credits</a><br>
|
|||
|
|
</span>
|
|||
|
|
</div>
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</table></td>
|
|||
|
|
<td width="13" background="../images/vert_line.jpg"><img src="../images/vert_line.jpg" width="13" height="1"></td>
|
|||
|
|
<td valign="top" width="533"><p class="header"><br>
|
|||
|
|
global_soundPan.scr</p>
|
|||
|
|
<p class="subheader">Dependencies</p>
|
|||
|
|
<p> None.</p>
|
|||
|
|
<p class="subheader">Function</p>
|
|||
|
|
<p> Randomly pick a sound from a passed in list, and then pan that sound
|
|||
|
|
around as it plays.</p>
|
|||
|
|
<p class="subheader"> How To Use</p>
|
|||
|
|
<p> Call the Init function to initialize the system. Use the AddSound function
|
|||
|
|
to input a list of sounds to choose from. YOU MUST ADD ALL THE SOUNDS
|
|||
|
|
BEFORE RUNNING THE SYSTEM! If a sound is added after the system is running,
|
|||
|
|
it could cause some timing issues and bork the whole thing. Then call
|
|||
|
|
the start function to begin running the system, call the stop function
|
|||
|
|
to hault the system.</p>
|
|||
|
|
<p>There should only be ONE of these systems initialized / running per level!
|
|||
|
|
Initializing / running multiple systems will cause weird and unexpected
|
|||
|
|
behavior!</p>
|
|||
|
|
<p class="subheader">External Functions</p>
|
|||
|
|
<p> <strong>globalSoundPan_Init()</strong></p>
|
|||
|
|
<blockquote>
|
|||
|
|
<p> <strong>Purpose:</strong><br>
|
|||
|
|
Initializes the system so it can function</p>
|
|||
|
|
<p><strong>Parms:</strong><br>
|
|||
|
|
None.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p> <strong>globalSoundPan_AddSound( _sound, _channel, _volume, _mindist,
|
|||
|
|
_chance, _length, _offset, _pause )</strong></p>
|
|||
|
|
<blockquote>
|
|||
|
|
<p> <strong>Purpose:</strong><br>
|
|||
|
|
Add sounds into the system. Must be done BEFORE the system is running.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<ul type="square">
|
|||
|
|
<strong>Parms:</strong>
|
|||
|
|
<li> <strong>_sound</strong> (string)<br>
|
|||
|
|
Path of the sound.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_channel</strong> (float)<br>
|
|||
|
|
The channel to play the sound on, should be 5 for most cases.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_volume</strong> (float)<br>
|
|||
|
|
0 - 1 scale of how loud it should play, 1 being the loudest.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_mindist</strong> (float)<br>
|
|||
|
|
Distance before it starts to fall off.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_chance</strong> (float)<br>
|
|||
|
|
0 - 1 chance of the sound playing when chosen, 1 means 'always'.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_length</strong> (float)<br>
|
|||
|
|
Amount of time the panner should be moving (in general should match
|
|||
|
|
the approx length of the sound file).<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_offset</strong> (float)<br>
|
|||
|
|
Distance for the panner to move.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
<li> <strong>_pause</strong> (float)<br>
|
|||
|
|
Number of seconds to wait before choosing another sound.<br>
|
|||
|
|
<br>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<p> <strong>globalSoundPan_Start()</strong></p>
|
|||
|
|
<blockquote>
|
|||
|
|
<p> <strong>Purpose:</strong><br>
|
|||
|
|
Begins running the system</p>
|
|||
|
|
<p><strong>Parms:</strong><br>
|
|||
|
|
None.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p> <strong>globalSoundPan_Stop() </strong></p>
|
|||
|
|
<blockquote>
|
|||
|
|
<p> <strong>Purpose:</strong><br>
|
|||
|
|
Stops running the system</p>
|
|||
|
|
<p><strong>Parms:</strong><br>
|
|||
|
|
None.</p>
|
|||
|
|
</blockquote>
|
|||
|
|
<p> </p></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td colspan="3"><img src="../images/footer.jpg" width="702" height="36" border="0" usemap="#Map"><br>
|
|||
|
|
<img src="../images/hor_line.jpg" width="702" height="1"></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td colspan="3" class="legal"><table width="100%" border="0" cellspacing="0" cellpadding="4">
|
|||
|
|
<tr>
|
|||
|
|
<td class="legal"> Copyright ©2003 Ritual Entertainment, Inc. All rights reserved.<br>
|
|||
|
|
Please do not email Ritual Entertainment with questions about the
|
|||
|
|
UberTools Game Development Kit. It is provided as is and is not supported by Ritual Entertainment.</td>
|
|||
|
|
<td><a href="http://www.ritual.com/tech/overview.html" target="_blank"><img src="../images/uber_logo.jpg" width="43" height="56" hspace="4" border="0"></a></td>
|
|||
|
|
<td><a href="http://www.ritual.com" target="_blank"><img src="../images/ritual_logo.jpg" width="100" height="56" hspace="4" border="0"></a></td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
<p align="center"> </p></td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
<map name="Map">
|
|||
|
|
<area shape="rect" coords="601,10,693,28" href="#top">
|
|||
|
|
</map>
|
|||
|
|
</body>
|
|||
|
|
</html>
|