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

OnActorBaseValueChange

(Difference between revisions)
Return to current revision
  1.  
    Gets called when an [wiki]Actor[/wiki]'s base value has changed.
    [h="2"] Declaration [/h]
    [highlight=cpp]
  2. -
    VAULTSCRIPT vaultmp::Void OnActorBaseValueChange(vaultmp::ID, vaultmp::Index, vaultmp::Value);
  3. +
    VAULTSCRIPT VAULTSPACE Void OnActorBaseValueChange(VAULTSPACE ID, VAULTSPACE Index, VAULTSPACE Value) _CPP(noexcept);
    [/highlight]
    [highlight=c]
  4.  
    forward OnActorBaseValueChange(ID, index, Float:value);
    [/highlight]
    [h="2"] Parameters [/h]
  5. -
    [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]
    [b][wiki="Value"]vaultmp::Value[/wiki][/b] - the new base value
  6. +
    [b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Actor[/wiki]
    [b][wiki="Index"]Index[/wiki][/b] - the index of the [wiki]Actor value[/wiki]
    [b][wiki="Value"]Value[/wiki][/b] - the new base value
  7.  
    [h="2"] Return value [/h]
    None.
  8. -
    [h="2"] Usage example (C++) [/h]
    [highlight=cpp]
    vaultmp::Void VAULTSCRIPT OnActorBaseValueChange(vaultmp::ID actor, vaultmp::Index index, vaultmp::Value value)
    {
    vaultmp::String value_name;
    value_name = ValueToString(index);
    // value_name now contains the string representation of the actor value
    }
    [/highlight]
  9.  
    [h="2"] Related pages [/h]
    [list][*][wiki]OnActorValueChange[/wiki]
    [*][wiki]ValueToString[/wiki]
    [/LIST]
    [category]VaultMP interface[/category]
    [category]Scripting callbacks[/category]