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

GetActorBaseValue

(Difference between revisions)
Return to current revision
Current Revision 04-11-2012, 09:06 PM
  1. -
    Retrieves the current base value of an [[Actor value]].

    == Declaration ==
    <code cpp>
  2. +
    Retrieves the current base value of an [wiki]Actor value[/wiki].
    [h="2"] Declaration [/h]
    [highlight=cpp]
  3.  
    VAULTSCRIPT vaultmp::Value (*GetActorBaseValue)(vaultmp::ID, vaultmp::Index);
    native Float:GetActorBaseValue(ID, index);
  4. -
    </code>
    == Parameters ==

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

    '''[[Index|vaultmp::Index]]''' - the index of the [[Actor value]]

    == Return value ==

    Returns a [[Value|vaultmp::Value]] containing the base value.

    == 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]
    [b][wiki="Index"]vaultmp::Index[/wiki][/b] - the index of the [wiki]Actor value[/wiki]
    [h="2"] Return value [/h]
    Returns a [wiki="Value"]vaultmp::Value[/wiki] containing the base value.
    [h="2"] Usage example (C++) [/h]
    [highlight=cpp]
  6.  
    vaultmp::Value value;
    value = GetActorBaseValue(actor, index);
  7. -
    </code>
  8. +
    [/highlight]
    [h="2"] Related pages [/h]
    [list][*][wiki]SetActorBaseValue[/wiki]
    [/LIST]
    [category]VaultMP interface[/category]
    [category]Scripting functions[/category]
    [category]Actor functions[/category]