This site has been archived and made available for preservation purposes. No edits can be made.

GetActorSneaking

(Difference between revisions)
Return to current revision
Current Revision 04-30-2012, 12:27 AM
  1. -
    Retrieves the sneaking state of an [[Actor]].

    == Declaration ==
    <code cpp>
  2. +
    Retrieves the sneaking state of an [wiki]Actor[/wiki].
    [h="2"] Declaration [/h]
    [highlight=cpp]
  3.  
    VAULTSCRIPT vaultmp::State (*GetActorSneaking)(vaultmp::ID);
    native Bool:GetActorSneaking(ID);
  4. -
    </code>
    == Parameters ==

    '''[[ID|vaultmp::ID]]''' - the ID of the [[Actor]]

    == Return value ==

    Returns a [[State|vaultmp::State]] containing the sneaking (''true'' - the [[Actor]] is sneaking, ''false'' - the [[Actor]] is not sneaking).

    == Usage example (C++) ==

    <code cpp>
  5. +
    [/highlight]
    [h="2"] Parameters [/h]
    [b][wiki="ID"]vaultmp::ID[/wiki][/b] - the ID of the [wiki]Actor[/wiki]
    [h="2"] Return value [/h]
    Returns a [wiki="State"]vaultmp::State[/wiki] containing the sneaking state ([wiki]True[/wiki] - the [wiki]Actor[/wiki] is sneaking, [wiki]False[/wiki] - the [wiki]Actor[/wiki] is not sneaking).
    [h="2"] Usage example (C++) [/h]
    [highlight=cpp]
  6.  
    vaultmp::State state;
    state = GetActorSneaking(actor);
  7. -
    </code>
  8. +
    [/highlight]
    [category]VaultMP interface[/category]
    [category]Scripting functions[/category]
    [category]Actor functions[/category]