Add ScriptTags trait

This allows actors to be tagged with arbitrary strings.
Also includes ScriptTagsInit and MapGlobal.ActorsWithTag
  which expose this functionality to map scripters.
This commit is contained in:
Taryn Hill
2016-03-23 17:18:35 -05:00
parent 728bad9565
commit 6582d0f480
4 changed files with 89 additions and 0 deletions

View File

@@ -9,6 +9,7 @@
*/
#endregion
using System.Collections.Generic;
using System.Linq;
using Eluant;
using OpenRA.Mods.Common.Traits;
@@ -113,5 +114,11 @@ namespace OpenRA.Mods.Common.Scripting
{
return actor.ActorID <= sma.LastMapActorID && actor.ActorID > sma.LastMapActorID - sma.Actors.Count;
}
[Desc("Returns a table of all actors tagged with the given string.")]
public Actor[] ActorsWithTag(string tag)
{
return Context.World.ActorsHavingTrait<ScriptTags>(t => t.HasTag(tag)).ToArray();
}
}
}

View File

@@ -79,12 +79,14 @@ namespace OpenRA.Mods.Common.Scripting
{
readonly IFacing facing;
readonly AutoTarget autotarget;
readonly ScriptTags scriptTags;
public GeneralProperties(ScriptContext context, Actor self)
: base(context, self)
{
facing = self.TraitOrDefault<IFacing>();
autotarget = self.TraitOrDefault<AutoTarget>();
scriptTags = self.TraitOrDefault<ScriptTags>();
}
[Desc("The actor position in cell coordinates.")]
@@ -162,5 +164,26 @@ namespace OpenRA.Mods.Common.Scripting
autotarget.Stance = stance;
}
}
[Desc("Specifies whether or not the actor supports 'tags'.")]
public bool IsTaggable { get { return scriptTags != null; } }
[Desc("Add a tag to the actor. Returns true on success, false otherwise (for example the actor may already have the given tag).")]
public bool AddTag(string tag)
{
return IsTaggable && scriptTags.AddTag(tag);
}
[Desc("Remove a tag from the actor. Returns true on success, false otherwise (tag was not present).")]
public bool RemoveTag(string tag)
{
return IsTaggable && scriptTags.RemoveTag(tag);
}
[Desc("Specifies whether or not the actor has a particular tag.")]
public bool HasTag(string tag)
{
return IsTaggable && scriptTags.HasTag(tag);
}
}
}