Initial generated import.

reference/functions/audio/func_audio_allocchannel.rst

@@ -0,0 +1,50 @@
+.. _func_audio_allocchannel:
+
+============
+AllocChannel
+============
+
+AllocChannel - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    AllocChannel:TChannel()
+
+Allocate audio channel
+
+Allocates an audio channel for use with #PlaySound and #CueSound.
+Once you are finished with an audio channel, you should use #StopChannel.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An audio channel object
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    'AllocChannel.bmx
+    
+    timer=createtimer(20)
+    
+    sound=LoadSound ("shoot.wav")
+    channel=AllocChannel()
+    
+    for i=1 to 20
+        waittimer timer
+        playsound sound,channel
+    next
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_audiodriverexists.rst

@@ -0,0 +1,35 @@
+.. _func_audio_audiodriverexists:
+
+=================
+AudioDriverExists
+=================
+
+AudioDriverExists - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    AudioDriverExists( name$ )
+
+Determine if an audio driver exists
+
+Returns True if the audio drvier specified by @driver exists.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_audiodrivers.rst

@@ -0,0 +1,35 @@
+.. _func_audio_audiodrivers:
+
+============
+AudioDrivers
+============
+
+AudioDrivers - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    AudioDrivers$[]()
+
+Get audio drivers
+
+Returns an array of strings, where each string describes an audio driver.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_channelplaying.rst

@@ -0,0 +1,49 @@
+.. _func_audio_channelplaying:
+
+==============
+ChannelPlaying
+==============
+
+ChannelPlaying - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ChannelPlaying( channel:TChannel )
+
+Determine whether an audio channel is playing
+
+#ChannelPlaying will return #False if either the channel has been paused using #PauseChannel,
+or stopped using #StopChannel.
+
+Parameters
+==========
+
+Return Values
+=============
+
+#True if @channel is currently playing
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' channelplaying.bmx
+    
+    sound = LoadSound ("shoot.wav")
+    
+    Input "Hit return to begin channelplaying test, use ctrl-C to exit"
+    
+    channel=playsound (sound)
+    while true
+        print "ChannelPlaying(channel)="+ChannelPlaying(channel)
+    wend
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_createaudiosample.rst

@@ -0,0 +1,67 @@
+.. _func_audio_createaudiosample:
+
+=================
+CreateAudioSample
+=================
+
+CreateAudioSample - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateAudioSample:TAudioSample( length,hertz,format )
+
+Create an audio sample
+
+@length is the number of samples to allocate for the sample. @hertz is the frequency in samples per second (hz)
+the audio sample will be played. @format should be one of:
+
+[ @Format | @Description
+
+* &SF_MONO8 | Mono unsigned 8 bit
+
+* &SF_MONO16LE | Mono signed 16 bit little endian
+
+* &SF_MONO16BE | Mono signed 16 bit big endian
+
+* &SF_STEREO8 | Stereo unsigned 8 bit
+
+* &SF_STEREO16LE | Stereo signed 16 bit little endian
+
+* &SF_STEREO16BE | Stereo signed 16 bit big endian
+]
+
+Parameters
+==========
+
+Return Values
+=============
+
+An audio sample object
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' createaudiosample.bmx
+    
+    Local sample:TAudioSample=CreateAudioSample( 32,11025,SF_MONO8 )
+    
+    For Local k=0 Until 32
+            sample.samples[k]=Sin(k*360/32)*127.5+127.5
+    Next
+    
+    Local sound:TSound=LoadSound( sample,True )
+    
+    PlaySound(sound)
+    
+    Input
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_createstaticaudiosample.rst

@@ -0,0 +1,38 @@
+.. _func_audio_createstaticaudiosample:
+
+=======================
+CreateStaticAudioSample
+=======================
+
+CreateStaticAudioSample - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateStaticAudioSample:TAudioSample( samples:Byte Ptr,length,hertz,format )
+
+Create an audio sample with existing data
+
+The memory referenced by a static audio sample is not released when the audio sample is
+deleted.
+
+See #CreateAudioSample for possile @format values.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An audio sample object that references an existing block of memory
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_cuesound.rst

@@ -0,0 +1,55 @@
+.. _func_audio_cuesound:
+
+========
+CueSound
+========
+
+CueSound - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CueSound:TChannel( sound:TSound,channel:TChannel=Null )
+
+Cue a sound
+
+Prepares a sound for playback through an audio channel.
+To actually start the sound, you must use #ResumeChannel.
+If no @channel is specified, #CueSound automatically allocates a channel for you.
+
+#CueSound allows you to setup various audio channel states such as volume, pan, depth
+and rate before a sound actually starts playing.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An audio channel object
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    Rem
+    CueSound example
+    End Rem
+    
+    sound=LoadSound("shoot.wav")
+    channel=CueSound(sound)
+    
+    Input "Press return key to play cued sound"
+    
+    ResumeChannel channel
+    
+    Input "Press return key to quit"
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_enableopenalaudio.rst

@@ -0,0 +1,36 @@
+.. _func_audio_enableopenalaudio:
+
+=================
+EnableOpenALAudio
+=================
+
+EnableOpenALAudio - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EnableOpenALAudio()
+
+Enable OpenAL Audio
+
+After successfully executing this command, OpenAL audio drivers will be added
+to the array of drivers returned by #AudioDrivers.
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if successful
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_loadaudiosample.rst

@@ -0,0 +1,33 @@
+.. _func_audio_loadaudiosample:
+
+===============
+LoadAudioSample
+===============
+
+LoadAudioSample - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    LoadAudioSample:TAudioSample( url:Object )
+
+Load an audio sample
+
+Parameters
+==========
+
+Return Values
+=============
+
+An audio sample object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_loadsound.rst

@@ -0,0 +1,56 @@
+.. _func_audio_loadsound:
+
+=========
+LoadSound
+=========
+
+LoadSound - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    LoadSound:TSound( url:Object,flags=0 )
+
+Load a sound
+
+@url can be either a string, a stream or a #TAudioSample object.
+The returned sound can be played using #PlaySound or #CueSound.
+
+The @flags parameter can be any combination of:
+
+[ @{Flag value} | @Effect
+* SOUND_LOOP | The sound should loop when played back.
+* SOUND_HARDWARE | The sound should be placed in onboard soundcard memory if possible.
+]
+
+To combine flags, use the binary 'or' operator: '|'.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A sound object
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    Rem
+    Load and Play a small example wav file.
+    End Rem
+    
+    sound=LoadSound("shoot.wav")
+    PlaySound sound
+    
+    Input "Press any key to continue"
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_openalinstalled.rst

@@ -0,0 +1,35 @@
+.. _func_audio_openalinstalled:
+
+===============
+OpenALInstalled
+===============
+
+OpenALInstalled - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    OpenALInstalled()
+
+Check if OpenAL is installed.
+
+This function allows you to determine whether OpenAL is installed on the current machine.
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if OpenAL is installed.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_pausechannel.rst

@@ -0,0 +1,35 @@
+.. _func_audio_pausechannel:
+
+============
+PauseChannel
+============
+
+PauseChannel - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PauseChannel( channel:TChannel )
+
+Pause audio channel playback
+
+Pauses audio channel playback.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_playsound.rst

@@ -0,0 +1,47 @@
+.. _func_audio_playsound:
+
+=========
+PlaySound
+=========
+
+PlaySound - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PlaySound:TChannel( sound:TSound,channel:TChannel=Null )
+
+Play a sound
+
+#PlaySound starts a sound playing through an audio channel.
+If no @channel is specified, #PlaySound automatically allocates a channel for you.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An audio channel object
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    Rem
+    Load and Play a small example wav file with looping.
+    End Rem
+    
+    sound=LoadSound("shoot.wav",true)
+    PlaySound sound
+    
+    Input "Press any key to continue"
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_resumechannel.rst

@@ -0,0 +1,35 @@
+.. _func_audio_resumechannel:
+
+=============
+ResumeChannel
+=============
+
+ResumeChannel - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ResumeChannel( channel:TChannel )
+
+Resume audio channel playback
+
+Resumes audio channel playback after it has been paused by #CueSound or #PauseChannel.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_setaudiodriver.rst

@@ -0,0 +1,35 @@
+.. _func_audio_setaudiodriver:
+
+==============
+SetAudioDriver
+==============
+
+SetAudioDriver - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SetAudioDriver( name$ )
+
+Set current audio driver
+
+Returns true if the audio driver was successfully set.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_setchanneldepth.rst

@@ -0,0 +1,63 @@
+.. _func_audio_setchanneldepth:
+
+===============
+SetChannelDepth
+===============
+
+SetChannelDepth - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SetChannelDepth( channel:TChannel,depth# )
+
+Set surround sound depth of an audio channel
+
+@depth should be in the range -1 (back) to 1 (front)
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' setchanneldepth.bmx
+    
+    Graphics 640, 480
+    
+    channel = AllocChannel ()
+    sound = LoadSound ("shoot.wav") ' Use a short sample...
+    
+    Repeat
+        If MouseHit(1) PlaySound sound,channel
+        
+        pan# = MouseX () / (640 / 2.0) - 1
+        depth# = MouseY () / (480 /2.0) -1
+        
+        SetChannelPan channel,pan
+        SetChannelDepth channel,depth
+    
+        Cls
+        DrawText "Click to play...", 240, 200
+        DrawText "Pan   : " + pan, 240, 220
+        DrawText "Depth : " + depth, 240, 240
+    
+        Flip
+    Until KeyHit (KEY_ESCAPE)
+    
+    End
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_setchannelpan.rst

@@ -0,0 +1,62 @@
+.. _func_audio_setchannelpan:
+
+=============
+SetChannelPan
+=============
+
+SetChannelPan - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SetChannelPan( channel:TChannel,pan# )
+
+Set stereo balance of an audio channel
+
+@pan should be in the range -1 (left) to 1 (right)
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' setchannelpan.bmx
+    
+    Graphics 640, 480
+    
+    channel = AllocChannel ()
+    sound = LoadSound ("shoot.wav") ' Use a short sample...
+    
+    Repeat
+        If MouseHit(1) PlaySound sound,channel
+        
+        pan# = MouseX () / (GraphicsWidth () / 2.0) - 1
+        vol# = 1 - MouseY () / 480.0
+        SetChannelPan channel, pan
+        SetChannelVolume channel, vol*2
+    
+        Cls
+        DrawText "Click to play...", 240, 200
+        DrawText "Pan   : " + pan, 240, 220
+        DrawText "Volume: " + vol, 240, 240
+    
+        Flip
+    Until KeyHit (KEY_ESCAPE)
+    
+    End
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_setchannelrate.rst

@@ -0,0 +1,53 @@
+.. _func_audio_setchannelrate:
+
+==============
+SetChannelRate
+==============
+
+SetChannelRate - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SetChannelRate( channel:TChannel,rate# )
+
+Set playback rate of an audio channel
+
+@rate is a multiplier used to modify the audio channel's frequency.
+For example, a rate of .5 will cause the audio channel
+to play at half speed (ie: an octave down) while a rate of 2 will
+cause the audio channel to play at double speed (ie: an octave up).
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' setchannelrate.bmx
+    
+    timer=CreateTimer(20)
+    
+    sound = LoadSound ("shoot.wav",True)
+    channel=CueSound(sound)
+    ResumeChannel channel
+    
+    For rate#=1.0 To 4 Step 0.01
+        WaitTimer timer
+        SetChannelRate channel,rate
+    Next
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_setchannelvolume.rst

@@ -0,0 +1,50 @@
+.. _func_audio_setchannelvolume:
+
+================
+SetChannelVolume
+================
+
+SetChannelVolume - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SetChannelVolume( channel:TChannel,volume# )
+
+Set playback volume of an audio channel
+
+@volume should be in the range 0 (silent) to 1 (full volume)
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' setchannelvolume.bmx
+    
+    timer=CreateTimer(20)
+    
+    sound = LoadSound ("shoot.wav")
+    
+    For volume#=.1 To 2 Step .05
+        WaitTimer timer
+        channel=CueSound(sound)
+        SetChannelVolume channel,volume
+        ResumeChannel channel
+    Next
+
+See Also
+========
+
+
+

reference/functions/audio/func_audio_stopchannel.rst

@@ -0,0 +1,52 @@
+.. _func_audio_stopchannel:
+
+===========
+StopChannel
+===========
+
+StopChannel - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    StopChannel( channel:TChannel )
+
+Stop an audio channel
+
+Shuts down an audio channel. Further commands using this channel will have no effect.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    Rem
+    StopChannel example
+    End Rem
+    
+    sound=LoadSound("shoot.wav",true)
+    channel=PlaySound(sound)
+    
+    print "channel="+channel
+    
+    Input "Press return key to stop sound"
+    
+    StopChannel channel
+    
+    Input "Press return key to quit"
+
+See Also
+========
+
+
+

reference/functions/audio/index.rst

@@ -0,0 +1,28 @@
+.. _reference_audio:
+
+
+
+.. toctree::
+    :hidden:
+
+    func_audio_allocchannel
+    func_audio_audiodriverexists
+    func_audio_audiodrivers
+    func_audio_channelplaying
+    func_audio_createaudiosample
+    func_audio_createstaticaudiosample
+    func_audio_cuesound
+    func_audio_enableopenalaudio
+    func_audio_loadaudiosample
+    func_audio_loadsound
+    func_audio_openalinstalled
+    func_audio_pausechannel
+    func_audio_playsound
+    func_audio_resumechannel
+    func_audio_setaudiodriver
+    func_audio_setchanneldepth
+    func_audio_setchannelpan
+    func_audio_setchannelrate
+    func_audio_setchannelvolume
+    func_audio_stopchannel
+

reference/functions/banks/func_banks_bankbuf.rst

@@ -0,0 +1,35 @@
+.. _func_banks_bankbuf:
+
+=======
+BankBuf
+=======
+
+BankBuf - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    BankBuf:Byte Ptr( bank:TBank )
+
+Get bank's memory buffer
+
+Please use #LockBank and #UnlockBank instead of this method.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A byte pointer to the bank's internal memory buffer
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_bankcapacity.rst

@@ -0,0 +1,38 @@
+.. _func_banks_bankcapacity:
+
+============
+BankCapacity
+============
+
+BankCapacity - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    BankCapacity( bank:TBank )
+
+Get capacity of bank
+
+The capacity of a bank is the size limit before a bank must allocate
+more memory due to a resize. Bank capacity may be increased due to a call
+to #ResizeBank by either 50% or the requested amount, whichever is greater.
+Capacity never decreases.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The capacity, in bytes, of the bank's internal memory buffer
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_banksize.rst

@@ -0,0 +1,33 @@
+.. _func_banks_banksize:
+
+========
+BankSize
+========
+
+BankSize - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    BankSize( bank:TBank )
+
+Get size of bank
+
+Parameters
+==========
+
+Return Values
+=============
+
+The size, in bytes, of the bank's internal memory buffer
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_copybank.rst

@@ -0,0 +1,36 @@
+.. _func_banks_copybank:
+
+========
+CopyBank
+========
+
+CopyBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CopyBank( src_bank:TBank,src_offset,dst_bank:TBank,dst_offset,count )
+
+Copy bank contents
+
+#CopyBank copies @count bytes from @src_offset in @src_bank to @dst_offset
+in @dst_bank.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_createbank.rst

@@ -0,0 +1,37 @@
+.. _func_banks_createbank:
+
+==========
+CreateBank
+==========
+
+CreateBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateBank:TBank( size=0 )
+
+Create a bank
+
+#CreateBank creates a Bank allocating a specified amount of memory that
+can be used for storage of binary data using the various Poke and
+Peek commands.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A bank object with an initial size of @size bytes
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_createstaticbank.rst

@@ -0,0 +1,36 @@
+.. _func_banks_createstaticbank:
+
+================
+CreateStaticBank
+================
+
+CreateStaticBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateStaticBank:TBank( buf:Byte Ptr,size )
+
+Create a bank with existing data
+
+The memory referenced by a static bank is not released when the bank is deleted.
+A static bank cannot be resized.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A bank object that references an existing block of memory
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_loadbank.rst

@@ -0,0 +1,36 @@
+.. _func_banks_loadbank:
+
+========
+LoadBank
+========
+
+LoadBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    LoadBank:TBank( url:Object )
+
+Load a bank
+
+#LoadBank reads the entire contents of a binary file from a specified @url into a newly
+created bank with a size matching that of the file.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A bank containing the binary contents of @url, or null if @url could not be opened
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_lockbank.rst

@@ -0,0 +1,38 @@
+.. _func_banks_lockbank:
+
+========
+LockBank
+========
+
+LockBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    LockBank:Byte Ptr( bank:TBank )
+
+Lock a bank's memory block
+
+While locked, a bank cannot be resized.
+
+After you have finished with a bank's memory block, you must use #UnlockBank
+to return it to the bank.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A byte pointer to the memory block controlled by the bank.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_peekbyte.rst

@@ -0,0 +1,35 @@
+.. _func_banks_peekbyte:
+
+========
+PeekByte
+========
+
+PeekByte - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekByte( bank:TBank,offset )
+
+Peek a byte from a bank
+
+A byte is an unsigned 8 bit value with a range of 0..255.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The byte value at the specified byte offset within the bank
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_peekdouble.rst

@@ -0,0 +1,35 @@
+.. _func_banks_peekdouble:
+
+==========
+PeekDouble
+==========
+
+PeekDouble - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekDouble!( bank:TBank,offset )
+
+Peek a double from a bank
+
+A double requires 8 bytes of storage
+
+Parameters
+==========
+
+Return Values
+=============
+
+The double value at the specified byte offset within the bank
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_peekfloat.rst

@@ -0,0 +1,35 @@
+.. _func_banks_peekfloat:
+
+=========
+PeekFloat
+=========
+
+PeekFloat - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekFloat#( bank:TBank,offset )
+
+Peek a float from a bank
+
+A float requires 4 bytes of storage
+
+Parameters
+==========
+
+Return Values
+=============
+
+The float value at the specified byte offset within the bank
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_peekint.rst

@@ -0,0 +1,35 @@
+.. _func_banks_peekint:
+
+=======
+PeekInt
+=======
+
+PeekInt - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekInt( bank:TBank,offset )
+
+Peek an int from a bank
+
+An int is a signed 32 bit value (4 bytes).
+
+Parameters
+==========
+
+Return Values
+=============
+
+The int value at the specified byte offset within the bank
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_peeklong.rst

@@ -0,0 +1,35 @@
+.. _func_banks_peeklong:
+
+========
+PeekLong
+========
+
+PeekLong - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekLong:Long( bank:TBank,offset )
+
+Peek a long integer from a bank
+
+A long is a 64 bit integer that requires 8 bytes of memory.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The long integer value at the specified byte offset within the bank
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_peekshort.rst

@@ -0,0 +1,35 @@
+.. _func_banks_peekshort:
+
+=========
+PeekShort
+=========
+
+PeekShort - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekShort( bank:TBank,offset )
+
+Peek a short from a bank
+
+A short is an unsigned 16 bit (2 bytes) value with a range of 0..65535.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The short value at the specified byte offset within the bank
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_pokebyte.rst

@@ -0,0 +1,33 @@
+.. _func_banks_pokebyte:
+
+========
+PokeByte
+========
+
+PokeByte - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PokeByte( bank:TBank,offset,value )
+
+Poke a byte into a bank
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_pokedouble.rst

@@ -0,0 +1,35 @@
+.. _func_banks_pokedouble:
+
+==========
+PokeDouble
+==========
+
+PokeDouble - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PokeDouble( bank:TBank,offset,value! )
+
+Poke a double into a bank
+
+A double requires 8 bytes of storage
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_pokefloat.rst

@@ -0,0 +1,35 @@
+.. _func_banks_pokefloat:
+
+=========
+PokeFloat
+=========
+
+PokeFloat - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PokeFloat( bank:TBank,offset,value# )
+
+Poke a float into a bank
+
+A float requires 4 bytes of storage
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_pokeint.rst

@@ -0,0 +1,35 @@
+.. _func_banks_pokeint:
+
+=======
+PokeInt
+=======
+
+PokeInt - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PokeInt( bank:TBank,offset,value )
+
+Poke an int into a bank
+
+An int is a signed 32 bit value that requires 4 bytes of storage.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_pokelong.rst

@@ -0,0 +1,35 @@
+.. _func_banks_pokelong:
+
+========
+PokeLong
+========
+
+PokeLong - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PokeLong( bank:TBank,offset,value:Long )
+
+Poke a long integer int into a bank
+
+A long is a 64 bit integer that requires 8 bytes of storage.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_pokeshort.rst

@@ -0,0 +1,35 @@
+.. _func_banks_pokeshort:
+
+=========
+PokeShort
+=========
+
+PokeShort - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PokeShort( bank:TBank,offset,value )
+
+Poke a short into a bank
+
+An short is an unsigned 16 bit value that requires 2 bytes of storage.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_readbank.rst

@@ -0,0 +1,33 @@
+.. _func_banks_readbank:
+
+========
+ReadBank
+========
+
+ReadBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ReadBank( bank:TBank,stream:TStream,offset,count )
+
+Read bytes from a Stream to a Bank
+
+Parameters
+==========
+
+Return Values
+=============
+
+The number of bytes successfully read from the Stream
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_resizebank.rst

@@ -0,0 +1,37 @@
+.. _func_banks_resizebank:
+
+==========
+ResizeBank
+==========
+
+ResizeBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ResizeBank( bank:TBank,size )
+
+Resize a bank
+
+#ResizeBank modifies the size limit of a bank. This may cause memory to be
+allocated if the requested size is greater than the bank's current capacity,
+see #BankCapacity for more information.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_savebank.rst

@@ -0,0 +1,36 @@
+.. _func_banks_savebank:
+
+========
+SaveBank
+========
+
+SaveBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SaveBank( bank:TBank,url:Object )
+
+Save a bank
+
+#SaveBank writes it's entire contents to a @url. If the @url is a file path a new
+file is created.
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if successful.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_unlockbank.rst

@@ -0,0 +1,36 @@
+.. _func_banks_unlockbank:
+
+==========
+UnlockBank
+==========
+
+UnlockBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    UnlockBank( bank:TBank )
+
+Unlock a bank's memory block
+
+After you have finished with a bank's memory block, you must use #UnlockBank
+to return it to the bank.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/func_banks_writebank.rst

@@ -0,0 +1,33 @@
+.. _func_banks_writebank:
+
+=========
+WriteBank
+=========
+
+WriteBank - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    WriteBank( bank:TBank,stream:TStream,offset,count )
+
+Write bytes from a Bank to a Stream
+
+Parameters
+==========
+
+Return Values
+=============
+
+The number of bytes successfully written to the Stream
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/banks/index.rst

@@ -0,0 +1,33 @@
+.. _reference_banks:
+
+
+
+.. toctree::
+    :hidden:
+
+    func_banks_bankbuf
+    func_banks_bankcapacity
+    func_banks_banksize
+    func_banks_copybank
+    func_banks_createbank
+    func_banks_createstaticbank
+    func_banks_loadbank
+    func_banks_lockbank
+    func_banks_peekbyte
+    func_banks_peekdouble
+    func_banks_peekfloat
+    func_banks_peekint
+    func_banks_peeklong
+    func_banks_peekshort
+    func_banks_pokebyte
+    func_banks_pokedouble
+    func_banks_pokefloat
+    func_banks_pokeint
+    func_banks_pokelong
+    func_banks_pokeshort
+    func_banks_readbank
+    func_banks_resizebank
+    func_banks_savebank
+    func_banks_unlockbank
+    func_banks_writebank
+

reference/functions/data/func_data_clearlist.rst

@@ -0,0 +1,34 @@
+.. _func_data_clearlist:
+
+=========
+ClearList
+=========
+
+ClearList - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ClearList( list:TList )
+
+Clear a linked list
+Removes all objects from @list.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_clearmap.rst

@@ -0,0 +1,35 @@
+.. _func_data_clearmap:
+
+========
+ClearMap
+========
+
+ClearMap - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ClearMap( map:TMap )
+
+Clear a map
+
+#ClearMap removes all keys and values from @map
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_copymap.rst

@@ -0,0 +1,33 @@
+.. _func_data_copymap:
+
+=======
+CopyMap
+=======
+
+CopyMap - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CopyMap:TMap( map:TMap )
+
+Copy a map
+
+Parameters
+==========
+
+Return Values
+=============
+
+A copy of @map
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_countlist.rst

@@ -0,0 +1,33 @@
+.. _func_data_countlist:
+
+=========
+CountList
+=========
+
+CountList - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CountList( list:TList )
+
+Count list length
+
+Parameters
+==========
+
+Return Values
+=============
+
+The numbers of objects in @list.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_createlist.rst

@@ -0,0 +1,53 @@
+.. _func_data_createlist:
+
+==========
+CreateList
+==========
+
+CreateList - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateList:TList()
+
+Create a linked list
+
+Parameters
+==========
+
+Return Values
+=============
+
+A new linked list object
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' createlist.bmx
+    
+    ' create a list to hold some objects
+    
+    list:TList=createlist()
+    
+    ' add some string objects to the list
+    
+    listaddlast list,"one"
+    listaddlast list,"two"
+    listaddlast list,"three"
+    
+    ' enumerate all the strings in the list
+    
+    for a$=eachin list
+        print a$
+    next
+
+See Also
+========
+
+
+

reference/functions/data/func_data_createmap.rst

@@ -0,0 +1,33 @@
+.. _func_data_createmap:
+
+=========
+CreateMap
+=========
+
+CreateMap - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateMap:TMap()
+
+Create a map
+
+Parameters
+==========
+
+Return Values
+=============
+
+A new map object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listaddfirst.rst

@@ -0,0 +1,33 @@
+.. _func_data_listaddfirst:
+
+============
+ListAddFirst
+============
+
+ListAddFirst - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListAddFirst:TLink( list:TList,value:Object )
+
+Add an object to a linked list
+
+Parameters
+==========
+
+Return Values
+=============
+
+A link object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listaddlast.rst

@@ -0,0 +1,33 @@
+.. _func_data_listaddlast:
+
+===========
+ListAddLast
+===========
+
+ListAddLast - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListAddLast:TLink( list:TList,value:Object )
+
+Add an object to a linked list
+
+Parameters
+==========
+
+Return Values
+=============
+
+A link object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listcontains.rst

@@ -0,0 +1,33 @@
+.. _func_data_listcontains:
+
+============
+ListContains
+============
+
+ListContains - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListContains( list:TList,value:Object )
+
+Check if list contains a value
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if list contains @value, else false
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listfindlink.rst

@@ -0,0 +1,33 @@
+.. _func_data_listfindlink:
+
+============
+ListFindLink
+============
+
+ListFindLink - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListFindLink:TLink( list:TList,value:Object )
+
+Find a link in a list
+
+Parameters
+==========
+
+Return Values
+=============
+
+The link containting @value
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listfromarray.rst

@@ -0,0 +1,33 @@
+.. _func_data_listfromarray:
+
+=============
+ListFromArray
+=============
+
+ListFromArray - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListFromArray:TList( arr:Object[] )
+
+Create a list from an array
+
+Parameters
+==========
+
+Return Values
+=============
+
+A new linked list
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listisempty.rst

@@ -0,0 +1,33 @@
+.. _func_data_listisempty:
+
+===========
+ListIsEmpty
+===========
+
+ListIsEmpty - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListIsEmpty( list:TList )
+
+Check if list is empty
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if list is empty, else false
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listremove.rst

@@ -0,0 +1,34 @@
+.. _func_data_listremove:
+
+==========
+ListRemove
+==========
+
+ListRemove - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListRemove( list:TList,value:Object )
+
+Remove an object from a linked list
+#ListRemove scans a list for the specified value and removes its link.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_listtoarray.rst

@@ -0,0 +1,33 @@
+.. _func_data_listtoarray:
+
+===========
+ListToArray
+===========
+
+ListToArray - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ListToArray:Object[]( list:TList )
+
+convert a list to an array
+
+Parameters
+==========
+
+Return Values
+=============
+
+An array of objects
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapcontains.rst

@@ -0,0 +1,33 @@
+.. _func_data_mapcontains:
+
+===========
+MapContains
+===========
+
+MapContains - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapContains( map:TMap,key:Object )
+
+Check if a map contains a key
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if @map contains @key
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapinsert.rst

@@ -0,0 +1,35 @@
+.. _func_data_mapinsert:
+
+=========
+MapInsert
+=========
+
+MapInsert - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapInsert( map:TMap,key:Object,value:Object )
+
+Insert a key/value pair into a map
+
+If @map already contained @key, it's value is overwritten with @value.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapisempty.rst

@@ -0,0 +1,33 @@
+.. _func_data_mapisempty:
+
+==========
+MapIsEmpty
+==========
+
+MapIsEmpty - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapIsEmpty( map:TMap )
+
+Check if a map is empty
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if @map is empty, otherwise false
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapkeys.rst

@@ -0,0 +1,36 @@
+.. _func_data_mapkeys:
+
+=======
+MapKeys
+=======
+
+MapKeys - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapKeys:TMapEnumerator( map:TMap )
+
+Get map keys
+
+The object returned by #MapKeys can be used with #EachIn to iterate through
+the keys in @map.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An iterator object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapremove.rst

@@ -0,0 +1,33 @@
+.. _func_data_mapremove:
+
+=========
+MapRemove
+=========
+
+MapRemove - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapRemove( map:TMap,key:Object )
+
+Remove a key/value pair from a map
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapvalueforkey.rst

@@ -0,0 +1,35 @@
+.. _func_data_mapvalueforkey:
+
+==============
+MapValueForKey
+==============
+
+MapValueForKey - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapValueForKey:Object( map:TMap,key:Object )
+
+Find a value given a key
+
+If @map does not contain @key, a #Null object is returned.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The value associated with @key
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_mapvalues.rst

@@ -0,0 +1,36 @@
+.. _func_data_mapvalues:
+
+=========
+MapValues
+=========
+
+MapValues - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    MapValues:TMapEnumerator( map:TMap )
+
+Get map values
+
+The object returned by #MapValues can be used with #EachIn to iterate through
+the values in @map.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An iterator object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_removelink.rst

@@ -0,0 +1,34 @@
+.. _func_data_removelink:
+
+==========
+RemoveLink
+==========
+
+RemoveLink - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    RemoveLink( link:TLink )
+
+Remove an object from a linked list
+#RemoveLink is more efficient than #ListRemove.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_reverselist.rst

@@ -0,0 +1,33 @@
+.. _func_data_reverselist:
+
+===========
+ReverseList
+===========
+
+ReverseList - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ReverseList( list:TList )
+
+Reverse the order of elements of a list
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_sortlist.rst

@@ -0,0 +1,33 @@
+.. _func_data_sortlist:
+
+========
+SortList
+========
+
+SortList - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SortList( list:TList,ascending=True,compareFunc( o1:Object,o2:Object ) )
+
+Sort a list
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/func_data_swaplists.rst

@@ -0,0 +1,33 @@
+.. _func_data_swaplists:
+
+=========
+SwapLists
+=========
+
+SwapLists - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    SwapLists( list_x:TList,list_y:TList )
+
+Swap the contents of 2 lists
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/data/index.rst

@@ -0,0 +1,33 @@
+.. _reference_data:
+
+
+
+.. toctree::
+    :hidden:
+
+    func_data_clearlist
+    func_data_clearmap
+    func_data_copymap
+    func_data_countlist
+    func_data_createlist
+    func_data_createmap
+    func_data_listaddfirst
+    func_data_listaddlast
+    func_data_listcontains
+    func_data_listfindlink
+    func_data_listfromarray
+    func_data_listisempty
+    func_data_listremove
+    func_data_listtoarray
+    func_data_mapcontains
+    func_data_mapinsert
+    func_data_mapisempty
+    func_data_mapkeys
+    func_data_mapremove
+    func_data_mapvalueforkey
+    func_data_mapvalues
+    func_data_removelink
+    func_data_reverselist
+    func_data_sortlist
+    func_data_swaplists
+

reference/functions/event/func_event_addhook.rst

@@ -0,0 +1,60 @@
+.. _func_event_addhook:
+
+=======
+AddHook
+=======
+
+AddHook - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    AddHook( id,func:Object( id,data:Object,context:Object ),context:Object=Null,priority=0 )
+
+Add a hook function
+
+Add a hook function to be executed when #RunHooks is called with the specified hook @id.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A hook object that can be used with the #RemoveHook command.
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    'This function will be automagically called every Flip
+    Function MyHook:Object( id,data:Object,context:Object )
+        Global count
+        
+        count:+1
+        If count Mod 10=0 Print "Flips="+count
+        
+    End Function
+    
+    'Add our hook to the system
+    AddHook FlipHook,MyHook
+    
+    'Some simple graphics
+    Graphics 640,480,0
+    
+    While Not KeyHit( KEY_ESCAPE )
+    
+        Cls
+        DrawText MouseX()+","+MouseY(),0,0
+        Flip
+    
+    Wend
+
+See Also
+========
+
+
+

reference/functions/event/func_event_allochookid.rst

@@ -0,0 +1,35 @@
+.. _func_event_allochookid:
+
+===========
+AllocHookId
+===========
+
+AllocHookId - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    AllocHookId()
+
+Allocate a hook id
+
+The returned hook id can be used with #AddHook, #RunHooks and #RemoveHook.
+
+Parameters
+==========
+
+Return Values
+=============
+
+An integer hook id
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_createtimer.rst

@@ -0,0 +1,40 @@
+.. _func_event_createtimer:
+
+===========
+CreateTimer
+===========
+
+CreateTimer - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CreateTimer:TTimer( hertz#,event:TEvent=Null )
+
+Create a timer
+
+#CreateTimer creates a timer object that 'ticks' @hertz times per second.
+
+Each time the timer ticks, @event will be emitted using #EmitEvent.
+
+If @event is Null, an event with an @id equal to EVENT_TIMERTICK and
+@source equal to the timer object will be emitted instead.
+
+Parameters
+==========
+
+Return Values
+=============
+
+A new timer object
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventdata.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventdata:
+
+=========
+EventData
+=========
+
+EventData - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventData()
+
+Get current event data
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @data field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventextra.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventextra:
+
+==========
+EventExtra
+==========
+
+EventExtra - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventExtra:Object()
+
+Get current event extra value
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @extra field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventid.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventid:
+
+=======
+EventID
+=======
+
+EventID - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventID()
+
+Get current event id
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @id field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventmods.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventmods:
+
+=========
+EventMods
+=========
+
+EventMods - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventMods()
+
+Get current event modifiers
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @mods field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventsource.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventsource:
+
+===========
+EventSource
+===========
+
+EventSource - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventSource:Object()
+
+Get current event source object
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @source field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventsourcehandle.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventsourcehandle:
+
+=================
+EventSourceHandle
+=================
+
+EventSourceHandle - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventSourceHandle()
+
+Get current event source object handle
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @source field of the #CurrentEvent global variable converted to an integer handle
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventtext.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventtext:
+
+=========
+EventText
+=========
+
+EventText - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventText$()
+
+Get current event extra value converted to a string
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @extra field of the #CurrentEvent global variable converted to a string
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventx.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventx:
+
+======
+EventX
+======
+
+EventX - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventX()
+
+Get current event x value
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @x field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_eventy.rst

@@ -0,0 +1,33 @@
+.. _func_event_eventy:
+
+======
+EventY
+======
+
+EventY - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    EventY()
+
+Get current event y value
+
+Parameters
+==========
+
+Return Values
+=============
+
+The @y field of the #CurrentEvent global variable
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_peekevent.rst

@@ -0,0 +1,38 @@
+.. _func_event_peekevent:
+
+=========
+PeekEvent
+=========
+
+PeekEvent - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PeekEvent:TEvent()
+
+Examine the next event in the event queue
+
+#PeekEvent examines the next event in the event queue, without removing it from the
+event queue or modifying the #CurrentEvent global variable.
+
+If there are no events in the event queue, #PeekEvent returns #Null.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_pollevent.rst

@@ -0,0 +1,38 @@
+.. _func_event_pollevent:
+
+=========
+PollEvent
+=========
+
+PollEvent - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PollEvent()
+
+Get the next event from the event queue
+
+#PollEvent removes an event from the event queue and updates the #CurrentEvent
+global variable.
+
+If there are no events in the event queue, #PollEvent returns 0.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The id of the next event in the event queue, or 0 if the event queue is empty
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_postevent.rst

@@ -0,0 +1,40 @@
+.. _func_event_postevent:
+
+=========
+PostEvent
+=========
+
+PostEvent - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    PostEvent( event:TEvent,update=False )
+
+Post an event to the event queue
+#PostEvent adds an event to the end of the event queue.
+
+The @update flag can be used to update an existing event. If @update is True
+and an event with the same @id and @source is found in the event
+queue, the existing event will be updated instead of @event
+being added to the event queue. This can be useful to prevent high frequency
+events such as timer events from flooding the event queue.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_removehook.rst

@@ -0,0 +1,35 @@
+.. _func_event_removehook:
+
+==========
+RemoveHook
+==========
+
+RemoveHook - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    RemoveHook( id,func:Object( id,data:Object,context:Object ),context:Object=Null )
+
+Remove a hook function
+
+Removes the hook function specified by @id, @func and @context.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_runhooks.rst

@@ -0,0 +1,39 @@
+.. _func_event_runhooks:
+
+========
+RunHooks
+========
+
+RunHooks - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    RunHooks:Object( id,data:Object )
+
+Run hook functions
+
+#RunHooks runs all hook functions that have been added for the specified hook @id.
+
+The first hook function is called with the provided @data object. The object returned by
+this function is then passed as the @data parameter to the next hook function and so on.
+Therefore, hook functions should generally return the @data parameter when finished.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The data produced by the last hook function
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_stoptimer.rst

@@ -0,0 +1,34 @@
+.. _func_event_stoptimer:
+
+=========
+StopTimer
+=========
+
+StopTimer - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    StopTimer( timer:TTimer )
+
+Stop a timer
+Once stopped, a timer can no longer be used.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_timerticks.rst

@@ -0,0 +1,33 @@
+.. _func_event_timerticks:
+
+==========
+TimerTicks
+==========
+
+TimerTicks - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    TimerTicks( timer:TTimer )
+
+Get timer tick counter
+
+Parameters
+==========
+
+Return Values
+=============
+
+The number of times @timer has ticked over
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_waitevent.rst

@@ -0,0 +1,39 @@
+.. _func_event_waitevent:
+
+=========
+WaitEvent
+=========
+
+WaitEvent - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    WaitEvent()
+
+Get the next event from the event queue, waiting if necessary
+
+#WaitEvent removes an event from the event queue and updates the #CurrentEvent
+global variable.
+
+If there are no events in the event queue, #WaitEvent halts program execution until
+an event is available.
+
+Parameters
+==========
+
+Return Values
+=============
+
+The id of the next event in the event queue
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/event/func_event_waittimer.rst

@@ -0,0 +1,41 @@
+.. _func_event_waittimer:
+
+=========
+WaitTimer
+=========
+
+WaitTimer - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    WaitTimer( timer:TTimer )
+
+Wait until a timer ticks
+
+Parameters
+==========
+
+Return Values
+=============
+
+The number of ticks since the last call to #WaitTimer
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    timer=CreateTimer( 10 )
+    
+    Repeat
+        Print "Ticks="+WaitTimer( timer )
+    Forever
+
+See Also
+========
+
+
+

reference/functions/event/index.rst

@@ -0,0 +1,29 @@
+.. _reference_event:
+
+
+
+.. toctree::
+    :hidden:
+
+    func_event_addhook
+    func_event_allochookid
+    func_event_createtimer
+    func_event_eventdata
+    func_event_eventextra
+    func_event_eventid
+    func_event_eventmods
+    func_event_eventsource
+    func_event_eventsourcehandle
+    func_event_eventtext
+    func_event_eventx
+    func_event_eventy
+    func_event_peekevent
+    func_event_pollevent
+    func_event_postevent
+    func_event_removehook
+    func_event_runhooks
+    func_event_stoptimer
+    func_event_timerticks
+    func_event_waitevent
+    func_event_waittimer
+

reference/functions/file/func_file_changedir.rst

@@ -0,0 +1,47 @@
+.. _func_file_changedir:
+
+=========
+ChangeDir
+=========
+
+ChangeDir - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    ChangeDir( path$ )
+
+Change current directory
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if successful
+
+Examples
+========
+
+.. code-block:: blitzmax
+
+    ' changedir.bmx
+    
+    print "CurrentDir()="+currentdir()
+    
+    ' change current folder to the parent folder
+    
+    changedir ".."
+    
+    ' print new CurrentDir()
+    
+    print "CurrentDir()="+currentdir()
+
+See Also
+========
+
+
+

reference/functions/file/func_file_closedir.rst

@@ -0,0 +1,33 @@
+.. _func_file_closedir:
+
+========
+CloseDir
+========
+
+CloseDir - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CloseDir( dir )
+
+Close a directory
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/file/func_file_closefile.rst

@@ -0,0 +1,37 @@
+.. _func_file_closefile:
+
+=========
+CloseFile
+=========
+
+CloseFile - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CloseFile( stream:TStream )
+
+Closes a file stream.
+
+After performing file operations on an open file make sure to
+close the file stream with either #CloseFile or the identical
+#CloseStream command.
+
+Parameters
+==========
+
+Return Values
+=============
+
+Nothing.
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/file/func_file_copydir.rst

@@ -0,0 +1,33 @@
+.. _func_file_copydir:
+
+=======
+CopyDir
+=======
+
+CopyDir - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CopyDir( src$,dst$ )
+
+Copy a directory
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if successful
+
+Examples
+========
+
+See Also
+========
+
+
+

reference/functions/file/func_file_copyfile.rst

@@ -0,0 +1,33 @@
+.. _func_file_copyfile:
+
+========
+CopyFile
+========
+
+CopyFile - 
+
+Description
+===========
+
+.. code-block:: blitzmax
+
+    CopyFile( src$,dst$ )
+
+Copy a file
+
+Parameters
+==========
+
+Return Values
+=============
+
+True if successful
+
+Examples
+========
+
+See Also
+========
+
+
+