Add a note about EnemyWatcher being required for On(Player)Discovered

This commit is contained in:
abcdefg30
2016-10-15 18:14:24 +02:00
parent 28e204a8ae
commit a36a77d637

View File

@@ -419,14 +419,16 @@ namespace OpenRA.Mods.Common.Scripting
} }
[Desc("Call a function when this actor is discovered by an enemy or a player with a Neutral stance. " + [Desc("Call a function when this actor is discovered by an enemy or a player with a Neutral stance. " +
"The callback function will be called as func(Actor discovered, Player discoverer).")] "The callback function will be called as func(Actor discovered, Player discoverer). +" +
"The player actor needs the 'EnemyWatcher' trait.")]
public void OnDiscovered(Actor a, LuaFunction func) public void OnDiscovered(Actor a, LuaFunction func)
{ {
GetScriptTriggers(a).RegisterCallback(Trigger.OnDiscovered, func, Context); GetScriptTriggers(a).RegisterCallback(Trigger.OnDiscovered, func, Context);
} }
[Desc("Call a function when this player is discovered by an enemy or neutral player. " + [Desc("Call a function when this player is discovered by an enemy or neutral player. " +
"The callback function will be called as func(Player discovered, Player discoverer, Actor discoveredActor).")] "The callback function will be called as func(Player discovered, Player discoverer, Actor discoveredActor)." +
"The player actor needs the 'EnemyWatcher' trait.")]
public void OnPlayerDiscovered(Player discovered, LuaFunction func) public void OnPlayerDiscovered(Player discovered, LuaFunction func)
{ {
GetScriptTriggers(discovered.PlayerActor).RegisterCallback(Trigger.OnPlayerDiscovered, func, Context); GetScriptTriggers(discovered.PlayerActor).RegisterCallback(Trigger.OnPlayerDiscovered, func, Context);