3 * =============================================================================
4 * SourceMod (C)2004-2008 AlliedModders LLC. All rights reserved.
5 * =============================================================================
7 * This file is part of the SourceMod/SourcePawn SDK.
9 * This program is free software; you can redistribute it and/or modify it under
10 * the terms of the GNU General Public License, version 3.0, as published by the
11 * Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
18 * You should have received a copy of the GNU General Public License along with
19 * this program. If not, see <http://www.gnu.org/licenses/>.
21 * As a special exception, AlliedModders LLC gives you permission to link the
22 * code of this program (as well as its derivative works) to "Half-Life 2," the
23 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
24 * by the Valve Corporation. You must obey the GNU General Public License in
25 * all respects for all other code used. Additionally, AlliedModders LLC grants
26 * this exception to all derivative works. AlliedModders LLC defines further
27 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
28 * or <http://www.sourcemod.net/license.php>.
33 #if defined _structs_included
36 #define _structs_included
39 * Struct Gamedata Notes:
43 * float/float* Not required
44 * char/char* Length of char array
45 * Vector/Vector* Not required
46 * ent/ent* Not required
50 * Retrieves an integer value from a struct.
52 * @param strct Struct Handle.
53 * @param member Member name to retrieve.
54 * @return Integer value.
55 * @error Undefined member, or member type mismatch.
57 native GetStructInt(Handle:strct, const String:member[]);
60 * Sets an integer value in a struct.
62 * @param strct Struct Handle.
63 * @param member Member name to set.
64 * @param value Value to set.
66 * @error Undefined member, or member type mismatch.
68 native SetStructInt(Handle:strct, const String:member[], value);
71 * Retrieves a float value from a struct.
73 * @param strct Struct Handle.
74 * @param member Member name to retrieve.
75 * @return Float value.
76 * @error Undefined member, or member type mismatch.
78 native Float:GetStructFloat(Handle:strct, const String:member[]);
81 * Sets a float value in a struct.
83 * @param strct Struct Handle.
84 * @param member Member name to set.
85 * @param value Value to set.
87 * @error Undefined member, or member type mismatch.
89 native SetStructFloat(Handle:strct, const String:member[], Float:value);
92 * Retrieves an integer value from a struct.
94 * @param strct Struct Handle.
95 * @param member Member name to retrieve.
96 * @param vec Buffer for the retrieved vector.
98 * @error Undefined member, or member type mismatch.
100 native GetStructVector(Handle:strct, const String:member[], Float:vec[3]);
103 * Sets a Vector value in a struct.
105 * @param strct Struct Handle.
106 * @param member Member name to set.
107 * @param vec Value to set.
109 * @error Undefined member, or member type mismatch.
111 native SetStructVector(Handle:strct, const String:member[], Float:vec[3]);
114 * Retrieves a string from a struct.
116 * @param strct Struct Handle.
117 * @param member Member name to retrieve.
118 * @param value Buffer for the retrieved string.
119 * @param maxlen Max length of the buffer
121 * @error Undefined member, or member type mismatch.
123 native GetStructString(Handle:strct, const String:member[], const String:value[], maxlen);
126 * Sets a string value in a struct.
128 * @param strct Struct Handle.
129 * @param member Member name to set.
130 * @param value Value to set.
132 * @error Undefined member, or member type mismatch.
134 native SetStructString(Handle:strct, const String:member[], String:value[]);
137 * Retrieves an entity handle from a struct.
139 * @param strct Struct Handle.
140 * @param member Member name to retrieve.
141 * @return Entity index.
142 * @error Undefined member, or member type mismatch.
144 native GetStructEnt(Handle:strct, const String:member[]);
147 * Sets an entity handle value in a struct.
149 * @param strct Struct Handle.
150 * @param member Member name to set.
151 * @param entity Entity index to set.
153 * @error Undefined member, or member type mismatch.
155 native SetStructEnt(Handle:strct, const String:member[], entity);
158 * Retrieves a struct handle to a FileWeaponInfo_t for the given weapon name.
159 * This handle needs to be closed when you have finished using it.
161 * @param weapon Weapon name to retrieve.
162 * @return Struct handle or INVALID_HANDLE on failure.
164 native Handle:GetWeaponStruct(const String:weapon[]);
167 * Do not edit below this line!
169 public Extension:__ext_struct =
171 name = "Struct Abstraction Extension",
172 file = "structs.ext",
174 #if defined REQUIRE_EXTENSIONS
