1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/plugins/include/structs.inc Thu Sep 18 15:32:22 2008 +1200
1.3 @@ -0,0 +1,179 @@
1.4 +/**
1.5 + * vim: set ts=4 :
1.6 + * =============================================================================
1.7 + * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
1.8 + * =============================================================================
1.9 + *
1.10 + * This file is part of the SourceMod/SourcePawn SDK.
1.11 + *
1.12 + * This program is free software; you can redistribute it and/or modify it under
1.13 + * the terms of the GNU General Public License, version 3.0, as published by the
1.14 + * Free Software Foundation.
1.15 + *
1.16 + * This program is distributed in the hope that it will be useful, but WITHOUT
1.17 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
1.18 + * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
1.19 + * details.
1.20 + *
1.21 + * You should have received a copy of the GNU General Public License along with
1.22 + * this program. If not, see <http://www.gnu.org/licenses/>.
1.23 + *
1.24 + * As a special exception, AlliedModders LLC gives you permission to link the
1.25 + * code of this program (as well as its derivative works) to "Half-Life 2," the
1.26 + * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
1.27 + * by the Valve Corporation. You must obey the GNU General Public License in
1.28 + * all respects for all other code used. Additionally, AlliedModders LLC grants
1.29 + * this exception to all derivative works. AlliedModders LLC defines further
1.30 + * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
1.31 + * or <http://www.sourcemod.net/license.php>.
1.32 + *
1.33 + * Version: $Id$
1.34 + */
1.35 +
1.36 +#if defined _structs_included
1.37 + #endinput
1.38 +#endif
1.39 +#define _structs_included
1.40 +
1.41 +/**
1.42 + * Struct Gamedata Notes:
1.43 + *
1.44 + * Types: Sizes:
1.45 + * int/int* 1/2/4
1.46 + * float/float* Not required
1.47 + * char/char* Length of char array
1.48 + * Vector/Vector* Not required
1.49 + * ent/ent* Not required
1.50 + */
1.51 +
1.52 +/**
1.53 + * Retrieves an integer value from a struct.
1.54 + *
1.55 + * @param strct Struct Handle.
1.56 + * @param member Member name to retrieve.
1.57 + * @return Integer value.
1.58 + * @error Undefined member, or member type mismatch.
1.59 + */
1.60 +native GetStructInt(Handle:strct, const String:member[]);
1.61 +
1.62 +/**
1.63 + * Sets an integer value in a struct.
1.64 + *
1.65 + * @param strct Struct Handle.
1.66 + * @param member Member name to set.
1.67 + * @param value Value to set.
1.68 + * @noreturn
1.69 + * @error Undefined member, or member type mismatch.
1.70 + */
1.71 +native SetStructInt(Handle:strct, const String:member[], value);
1.72 +
1.73 +/**
1.74 + * Retrieves a float value from a struct.
1.75 + *
1.76 + * @param strct Struct Handle.
1.77 + * @param member Member name to retrieve.
1.78 + * @return Float value.
1.79 + * @error Undefined member, or member type mismatch.
1.80 + */
1.81 +native Float:GetStructFloat(Handle:strct, const String:member[]);
1.82 +
1.83 +/**
1.84 + * Sets a float value in a struct.
1.85 + *
1.86 + * @param strct Struct Handle.
1.87 + * @param member Member name to set.
1.88 + * @param value Value to set.
1.89 + * @noreturn
1.90 + * @error Undefined member, or member type mismatch.
1.91 + */
1.92 +native SetStructFloat(Handle:strct, const String:member[], Float:value);
1.93 +
1.94 +/**
1.95 + * Retrieves an integer value from a struct.
1.96 + *
1.97 + * @param strct Struct Handle.
1.98 + * @param member Member name to retrieve.
1.99 + * @param vec Buffer for the retrieved vector.
1.100 + * @noreturn
1.101 + * @error Undefined member, or member type mismatch.
1.102 + */
1.103 +native GetStructVector(Handle:strct, const String:member[], Float:vec[3]);
1.104 +
1.105 +/**
1.106 + * Sets a Vector value in a struct.
1.107 + *
1.108 + * @param strct Struct Handle.
1.109 + * @param member Member name to set.
1.110 + * @param vec Value to set.
1.111 + * @noreturn
1.112 + * @error Undefined member, or member type mismatch.
1.113 + */
1.114 +native SetStructVector(Handle:strct, const String:member[], Float:vec[3]);
1.115 +
1.116 +/**
1.117 + * Retrieves a string from a struct.
1.118 + *
1.119 + * @param strct Struct Handle.
1.120 + * @param member Member name to retrieve.
1.121 + * @param value Buffer for the retrieved string.
1.122 + * @param maxlen Max length of the buffer
1.123 + * @noreturn
1.124 + * @error Undefined member, or member type mismatch.
1.125 + */
1.126 +native GetStructString(Handle:strct, const String:member[], const String:value[], maxlen);
1.127 +
1.128 +/**
1.129 + * Sets a string value in a struct.
1.130 + *
1.131 + * @param strct Struct Handle.
1.132 + * @param member Member name to set.
1.133 + * @param value Value to set.
1.134 + * @noreturn
1.135 + * @error Undefined member, or member type mismatch.
1.136 + */
1.137 +native SetStructString(Handle:strct, const String:member[], String:value[]);
1.138 +
1.139 +/**
1.140 + * Retrieves an entity handle from a struct.
1.141 + *
1.142 + * @param strct Struct Handle.
1.143 + * @param member Member name to retrieve.
1.144 + * @return Entity index.
1.145 + * @error Undefined member, or member type mismatch.
1.146 + */
1.147 +native GetStructEnt(Handle:strct, const String:member[]);
1.148 +
1.149 +/**
1.150 + * Sets an entity handle value in a struct.
1.151 + *
1.152 + * @param strct Struct Handle.
1.153 + * @param member Member name to set.
1.154 + * @param entity Entity index to set.
1.155 + * @noreturn
1.156 + * @error Undefined member, or member type mismatch.
1.157 + */
1.158 +native SetStructEnt(Handle:strct, const String:member[], entity);
1.159 +
1.160 +/**
1.161 + * Retrieves a struct handle to a FileWeaponInfo_t for the given weapon name.
1.162 + * This handle needs to be closed when you have finished using it.
1.163 + *
1.164 + * @param weapon Weapon name to retrieve.
1.165 + * @return Struct handle or INVALID_HANDLE on failure.
1.166 + */
1.167 +native Handle:GetWeaponStruct(const String:weapon[]);
1.168 +
1.169 +/**
1.170 + * Do not edit below this line!
1.171 + */
1.172 +public Extension:__ext_struct =
1.173 +{
1.174 + name = "Struct Abstraction Extension",
1.175 + file = "structs.ext",
1.176 + autoload = 1,
1.177 +#if defined REQUIRE_EXTENSIONS
1.178 + required = 1,
1.179 +#else
1.180 + required = 0,
1.181 +#endif
1.182 +};
