OnActorValueChange

Current Revision 04-28-2013, 02:03 AM

Gets called when an [wiki]Actor[/wiki]'s value has changed.
[h="2"] Declaration [/h]
-

<code cpp>
VAULTSCRIPT void OnActorValueChange(vaultmp::ID, vaultmp::Index, vaultmp::Value);
forward OnActorValueChange(ID, index, Float:value);
</code>
+

[highlight=cpp]
VAULTSCRIPT VAULTSPACE Void OnActorValueChange(VAULTSPACE ID, VAULTSPACE ActorValue, VAULTSPACE Value) VAULTCPP(noexcept);
[/highlight]
[highlight=c]
forward OnActorValueChange(ID, ActorValue:index, Float:value);
[/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]
[b][wiki="Value"]vaultmp::Value[/wiki][/b] - the new value
+

[b][wiki="ID"]ID[/wiki][/b] - the ID of the [wiki]Actor[/wiki]
[b][wiki="ActorValue"]ActorValue[/wiki][/b] - the [wiki="ActorValue"]Actor value[/wiki]
[b][wiki="Value"]Value[/wiki][/b] - the new value
[h="2"] Return value [/h]
None.
-

[h="2"] Usage example (C++) [/h]
<code cpp>
void VAULTSCRIPT OnActorValueChange(vaultmp::ID actor, vaultmp::Index index, vaultmp::Value value)
{
std::string value_name;
value_name = ValueToString(index);
// value_name now contains the string representation of the actor value
}
</code>
[h="2"] Related pages [/h]
[list][*][wiki]OnActorBaseValueChange[/wiki]
[*][wiki]ValueToString[/wiki]
[/LIST]
[category]VaultMP interface[/category]
[category]Scripting callbacks[/category]