plugins/include/sdktools_entinput.inc
author David Anderson <dvander@alliedmods.net>
Mon Oct 29 00:33:20 2007 +0000 (2007-10-29)
changeset 1652 eacd2002cda8
parent 1498 e7eb59f70ff6
child 1947 e73a1e51833b
permissions -rw-r--r--
fixed nonsense documentation comment
faluco@1498
     1
/**
faluco@1498
     2
 * vim: set ts=4 :
faluco@1498
     3
 * =============================================================================
faluco@1498
     4
 * SourceMod (C)2004-2007 AlliedModders LLC.  All rights reserved.
faluco@1498
     5
 * =============================================================================
faluco@1498
     6
 *
faluco@1498
     7
 * This file is part of the SourceMod/SourcePawn SDK.
faluco@1498
     8
 *
faluco@1498
     9
 * This program is free software; you can redistribute it and/or modify it under
faluco@1498
    10
 * the terms of the GNU General Public License, version 3.0, as published by the
faluco@1498
    11
 * Free Software Foundation.
faluco@1498
    12
 * 
faluco@1498
    13
 * This program is distributed in the hope that it will be useful, but WITHOUT
faluco@1498
    14
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
faluco@1498
    15
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
faluco@1498
    16
 * details.
faluco@1498
    17
 *
faluco@1498
    18
 * You should have received a copy of the GNU General Public License along with
faluco@1498
    19
 * this program.  If not, see <http://www.gnu.org/licenses/>.
faluco@1498
    20
 *
faluco@1498
    21
 * As a special exception, AlliedModders LLC gives you permission to link the
faluco@1498
    22
 * code of this program (as well as its derivative works) to "Half-Life 2," the
faluco@1498
    23
 * "Source Engine," the "SourcePawn JIT," and any Game MODs that run on software
faluco@1498
    24
 * by the Valve Corporation.  You must obey the GNU General Public License in
faluco@1498
    25
 * all respects for all other code used.  Additionally, AlliedModders LLC grants
faluco@1498
    26
 * this exception to all derivative works.  AlliedModders LLC defines further
faluco@1498
    27
 * exceptions, found in LICENSE.txt (as of this writing, version JULY-31-2007),
faluco@1498
    28
 * or <http://www.sourcemod.net/license.php>.
faluco@1498
    29
 *
faluco@1498
    30
 * Version: $Id$
faluco@1498
    31
 */
faluco@1498
    32
faluco@1498
    33
#if defined _sdktools_entinput_included
faluco@1498
    34
  #endinput
faluco@1498
    35
#endif
faluco@1498
    36
#define _sdktools_entinput_included
faluco@1498
    37
faluco@1498
    38
/**
faluco@1498
    39
 * Invokes a named input method on an entity.  
faluco@1498
    40
 *
faluco@1498
    41
 * After completion (successful or not), the current global variant is re-initalized.
faluco@1498
    42
 *
faluco@1498
    43
 * @param dest		Destination entity index.
faluco@1498
    44
 * @param input		Input action.
faluco@1498
    45
 * @param activator	Entity index which initiated the sequence of actions (-1 for a NULL entity).
faluco@1498
    46
 * @param caller	Entity index from which this event is sent (-1 for a NULL entity).
faluco@1498
    47
 * @param outputid	Unknown.
faluco@1498
    48
 * @return		True if successful otherwise false.
faluco@1498
    49
 * @error		Invalid entity index or no mod support.
faluco@1498
    50
 */
faluco@1498
    51
native bool:AcceptEntityInput(dest, const String:input[], activator=-1, caller=-1, outputid=0);
faluco@1498
    52
faluco@1498
    53
/**
faluco@1498
    54
 * Sets a bool value in the global variant object.
faluco@1498
    55
 *
faluco@1498
    56
 * @param val		Input value.
faluco@1498
    57
 * @noreturn
faluco@1498
    58
 */
faluco@1498
    59
native SetVariantBool(bool:val);
faluco@1498
    60
faluco@1498
    61
/**
faluco@1498
    62
 * Sets a string in the global variant object.
faluco@1498
    63
 *
faluco@1498
    64
 * @param str		Input string.
faluco@1498
    65
 * @noreturn
faluco@1498
    66
 */
faluco@1498
    67
native SetVariantString(const String:str[]);
faluco@1498
    68
faluco@1498
    69
/**
faluco@1498
    70
 * Sets an integer value in the global variant object.
faluco@1498
    71
 *
faluco@1498
    72
 * @param val		Input value.
faluco@1498
    73
 * @noreturn
faluco@1498
    74
 */
faluco@1498
    75
native SetVariantInt(val);
faluco@1498
    76
faluco@1498
    77
/**
faluco@1498
    78
 * Sets a floating point value in the global variant object.
faluco@1498
    79
 *
faluco@1498
    80
 * @param val		Input value.
faluco@1498
    81
 * @noreturn
faluco@1498
    82
 */
faluco@1498
    83
native SetVariantFloat(Float:val);
faluco@1498
    84
faluco@1498
    85
/**
faluco@1498
    86
 * Sets a 3D vector in the global variant object.
faluco@1498
    87
 *
faluco@1498
    88
 * @param vec		Input vector.
faluco@1498
    89
 * @noreturn
faluco@1498
    90
 */
faluco@1498
    91
native SetVariantVector3D(const Float:vec[3]);
faluco@1498
    92
faluco@1498
    93
/**
faluco@1498
    94
 * Sets a 3D position vector in the global variant object.
faluco@1498
    95
 *
faluco@1498
    96
 * @param vec		Input position vector.
faluco@1498
    97
 * @noreturn
faluco@1498
    98
 */
faluco@1498
    99
native SetVariantPosVector3D(const Float:vec[3]);
faluco@1498
   100
faluco@1498
   101
/**
faluco@1498
   102
 * Sets a color in the global variant object.
faluco@1498
   103
 *
faluco@1498
   104
 * @param color		Input color.
faluco@1498
   105
 * @noreturn
faluco@1498
   106
 */
faluco@1498
   107
native SetVariantColor(const color[4]);
faluco@1498
   108
faluco@1498
   109
/**
faluco@1498
   110
 * Sets an entity in the global variant object.
faluco@1498
   111
 *
faluco@1498
   112
 * @param		Entity index.
faluco@1498
   113
 * @noreturn
faluco@1498
   114
 * @error		Invalid entity index.
faluco@1498
   115
 */
faluco@1498
   116
native SetVariantEntity(entity);