add documentation to crate spawner / dropper

This commit is contained in:
Matthias Mailänder
2013-04-02 16:25:12 +02:00
parent d735242cd0
commit 2d77a46aec
2 changed files with 22 additions and 10 deletions

View File

@@ -20,12 +20,18 @@ namespace OpenRA.Mods.RA
{ {
public class CrateDropInfo : ITraitInfo public class CrateDropInfo : ITraitInfo
{ {
public readonly int Minimum = 1; // Minimum number of crates [Desc("Minimum number of crates")]
public readonly int Maximum = 255; // Maximum number of crates public readonly int Minimum = 1;
public readonly string[] ValidGround = {"Clear", "Rough", "Road", "Ore", "Beach"}; // Which terrain types can we drop on? [Desc("Maximum number of crates")]
public readonly int Maximum = 255;
[Desc("Which terrain types can we drop on?")]
public readonly string[] ValidGround = {"Clear", "Rough", "Road", "Ore", "Beach"};
[Desc("Which terrain types count as water?")]
public readonly string[] ValidWater = {"Water"}; public readonly string[] ValidWater = {"Water"};
public readonly int SpawnInterval = 180; // Average time (seconds) between crate spawn [Desc("Average time (seconds) between crate spawn")]
public readonly float WaterChance = .2f; // Chance of generating a water crate instead of a land crate public readonly int SpawnInterval = 180;
[Desc("Chance of generating a water crate instead of a land crate")]
public readonly float WaterChance = .2f;
public object Create (ActorInitializer init) { return new CrateDrop(this); } public object Create (ActorInitializer init) { return new CrateDrop(this); }
} }

View File

@@ -19,12 +19,18 @@ namespace OpenRA.Mods.RA
{ {
public class CrateSpawnerInfo : TraitInfo<CrateSpawner> public class CrateSpawnerInfo : TraitInfo<CrateSpawner>
{ {
public readonly int Minimum = 1; // Minimum number of crates [Desc("Minimum number of crates")]
public readonly int Maximum = 255; // Maximum number of crates public readonly int Minimum = 1;
public readonly string[] ValidGround = {"Clear", "Rough", "Road", "Ore", "Beach"}; // Which terrain types can we drop on? [Desc("Maximum number of crates")]
public readonly int Maximum = 255;
[Desc("Which terrain types can we drop on?")]
public readonly string[] ValidGround = {"Clear", "Rough", "Road", "Ore", "Beach"};
[Desc("Which terrain types count as water?")]
public readonly string[] ValidWater = {"Water"}; public readonly string[] ValidWater = {"Water"};
public readonly int SpawnInterval = 180; // Average time (seconds) between crate spawn [Desc("Average time (seconds) between crate spawn")]
public readonly float WaterChance = .2f; // Chance of generating a water crate instead of a land crate public readonly int SpawnInterval = 180;
[Desc("Chance of generating a water crate instead of a land crate")]
public readonly float WaterChance = .2f;
} }
public class CrateSpawner : ITick public class CrateSpawner : ITick