dvander@1750: /**
dvander@1750: * vim: set ts=4 :
dvander@1750: * =============================================================================
dvander@1750: * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
dvander@1750: * =============================================================================
dvander@1750: *
dvander@1750: * This file is part of the SourceMod/SourcePawn SDK.
dvander@1750: *
dvander@1750: * This program is free software; you can redistribute it and/or modify it under
dvander@1750: * the terms of the GNU General Public License, version 3.0, as published by the
dvander@1750: * Free Software Foundation.
dvander@1750: *
dvander@1750: * This program is distributed in the hope that it will be useful, but WITHOUT
dvander@1750: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
dvander@1750: * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
dvander@1750: * details.
dvander@1750: *
dvander@1750: * You should have received a copy of the GNU General Public License along with
dvander@1750: * this program. If not, see .
dvander@1750: *
dvander@1750: * As a special exception, AlliedModders LLC gives you permission to link the
dvander@1750: * code of this program (as well as its derivative works) to "Half-Life 2," the
dvander@1750: * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
dvander@1750: * by the Valve Corporation. You must obey the GNU General Public License in
dvander@1750: * all respects for all other code used. Additionally, AlliedModders LLC grants
dvander@1750: * this exception to all derivative works. AlliedModders LLC defines further
dvander@1750: * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
dvander@1750: * or .
dvander@1750: *
dvander@1750: * Version: $Id$
dvander@1750: */
dvander@1750:
dvander@1750: #if defined _bitbuffer_included
dvander@1750: #endinput
dvander@1750: #endif
dvander@1750: #define _bitbuffer_included
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a single bit to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param bit Bit to write (true for 1, false for 0).
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteBool(Handle:bf, bool:bit);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a byte to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param byte Byte to write (value will be written as 8bit).
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteByte(Handle:bf, byte);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a byte to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param chr Character to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteChar(Handle:bf, chr);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a 16bit integer to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param num Integer to write (value will be written as 16bit).
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteShort(Handle:bf, num);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a 16bit unsigned integer to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param num Integer to write (value will be written as 16bit).
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteWord(Handle:bf, num);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a normal integer to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param num Integer to write (value will be written as 32bit).
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteNum(Handle:bf, num);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a floating point number to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param num Number to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteFloat(Handle:bf, Float:num);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a string to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param string Text string to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteString(Handle:bf, const String:string[]);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes an entity to a writable bitbuffer (bf_write).
dvander@1750: * @note This is a wrapper around BfWriteShort().
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param ent Entity index to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle, or invalid entity.
dvander@1750: */
dvander@1750: native BfWriteEntity(Handle:bf, ent);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a bit angle to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param angle Angle to write.
dvander@1750: * @param numBits Optional number of bits to use.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteAngle(Handle:bf, Float:angle, numBits=8);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a coordinate to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param coord Coordinate to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteCoord(Handle:bf, Float:coord);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a 3D vector of coordinates to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param coord Coordinate array to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteVecCoord(Handle:bf, Float:coord[3]);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a 3D normal vector to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param vec Vector to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteVecNormal(Handle:bf, Float:vec[3]);
dvander@1750:
dvander@1750: /**
dvander@1750: * Writes a 3D angle vector to a writable bitbuffer (bf_write).
dvander@1750: *
dvander@1750: * @param bf bf_write handle to write to.
dvander@1750: * @param angles Angle vector to write.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfWriteAngles(Handle:bf, Float:angles[3]);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a single bit from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Bit value read.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native bool:BfReadBool(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a byte from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Byte value read (read as 8bit).
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadByte(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a character from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Character value read.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadChar(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a 16bit integer from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Integer value read (read as 16bit).
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadShort(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a 16bit unsigned integer from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Integer value read (read as 16bit).
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadWord(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a normal integer to a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Integer value read (read as 32bit).
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadNum(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a floating point number from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Floating point value read.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native Float:BfReadFloat(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a string from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @param buffer Destination string buffer.
dvander@1750: * @param maxlength Maximum length of output string buffer.
dvander@1750: * @param line If true the buffer will be copied until it reaches a '\n' or a null terminator.
dvander@1750: * @return Number of bytes written to the buffer. If the bitbuffer stream overflowed,
dvander@1750: * that is, had no terminator before the end of the stream, then a negative
dvander@1750: * number will be returned equal to the number of characters written to the
dvander@1750: * buffer minus 1. The buffer will be null terminated regardless of the
dvander@1750: * return value.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadString(Handle:bf, String:buffer[], maxlength, bool:line=false);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads an entity from a readable bitbuffer (bf_read).
dvander@1750: * @note This is a wrapper around BfReadShort().
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Entity index read.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadEntity(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a bit angle from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @param numBits Optional number of bits to use.
dvander@1750: * @return Angle read.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native Float:BfReadAngle(Handle:bf, numBits=8);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a coordinate from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @return Coordinate read.
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native Float:BfReadCoord(Handle:bf);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a 3D vector of coordinates from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @param coord Destination coordinate array.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadVecCoord(Handle:bf, Float:coord[3]);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a 3D normal vector from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @param vec Destination vector array.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadVecNormal(Handle:bf, Float:vec[3]);
dvander@1750:
dvander@1750: /**
dvander@1750: * Reads a 3D angle vector from a readable bitbuffer (bf_read).
dvander@1750: *
dvander@1750: * @param bf bf_read handle to read from.
dvander@1750: * @param angles Destination angle vector.
dvander@1750: * @noreturn
dvander@1750: * @error Invalid or incorrect Handle.
dvander@1750: */
dvander@1750: native BfReadAngles(Handle:bf, Float:angles[3]);
pred@1872:
pred@1872: /**
pred@1872: * Returns the number of bytes left in a readable bitbuffer (bf_read).
pred@1872: *
pred@1872: * @param bf bf_read handle to read from.
pred@1872: * @return Number of bytes left unread.
pred@1872: * @error Invalid or incorrect Handle.
pred@1872: */
pred@1872: native BfGetNumBytesLeft(Handle:bf);