themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Add next block of documentation, change some names of the routes using verbs to better tell what that verb is used for.

Browse source
This commit is contained in:
Zack Piispanen 2015-04-05 18:50:21 -04:00
parent 20e39f331f
commit 2888bc5fe4
1 changed files with 30 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

35
TShockAPI/Rest/RestManager.cs
View file

@ -79,7 +79,7 @@ namespace TShockAPI
[AttributeUsage(AttributeTargets.Method, AllowMultiple = true)] [AttributeUsage(AttributeTargets.Method, AllowMultiple = true)]
public class Verb : ParameterAttribute public class Verb : ParameterAttribute
{ {
public Verb(string name, bool req, string desc, Type type) : base(name, req, desc, type) { } public Verb(string name, string desc, Type type) : base(name, true, desc, type) { }
} }
[AttributeUsage(AttributeTargets.Method)] [AttributeUsage(AttributeTargets.Method)]
@ -140,9 +140,9 @@ namespace TShockAPI
// World Commands // World Commands
Rest.Register(new SecureRestCommand("/world/read", WorldRead)); Rest.Register(new SecureRestCommand("/world/read", WorldRead));
Rest.Register(new SecureRestCommand("/world/meteor", WorldMeteor, RestPermissions.restcauseevents)); Rest.Register(new SecureRestCommand("/world/meteor", WorldMeteor, RestPermissions.restcauseevents));
Rest.Register(new SecureRestCommand("/world/bloodmoon/{bool}", WorldBloodmoon, RestPermissions.restcauseevents)); Rest.Register(new SecureRestCommand("/world/bloodmoon/{bloodmoon}", WorldBloodmoon, RestPermissions.restcauseevents));
Rest.Register(new SecureRestCommand("/v2/world/save", WorldSave, RestPermissions.restcfg)); Rest.Register(new SecureRestCommand("/v2/world/save", WorldSave, RestPermissions.restcfg));
Rest.Register(new SecureRestCommand("/v2/world/autosave/state/{bool}", WorldChangeSaveSettings, RestPermissions.restcfg)); Rest.Register(new SecureRestCommand("/v2/world/autosave/state/{state}", WorldChangeSaveSettings, RestPermissions.restcfg));
Rest.Register(new SecureRestCommand("/v2/world/butcher", WorldButcher, RestPermissions.restbutcher)); Rest.Register(new SecureRestCommand("/v2/world/butcher", WorldButcher, RestPermissions.restbutcher));
// Player Commands // Player Commands
@ -651,16 +651,24 @@ namespace TShockAPI
#region RestWorldMethods #region RestWorldMethods
[Route("/v2/world/autosave/state/{state}")]
[Permission(RestPermissions.restcfg)]
[Verb("state", "The status for autosave.", typeof(bool))]
[Token]
private object WorldChangeSaveSettings(RestRequestArgs args) private object WorldChangeSaveSettings(RestRequestArgs args)
{ {
bool autoSave; bool autoSave;
if (!bool.TryParse(args.Verbs["bool"], out autoSave)) if (!bool.TryParse(args.Verbs["state"], out autoSave))
return RestInvalidParam("state"); return RestInvalidParam("state");
TShock.Config.AutoSave = autoSave; TShock.Config.AutoSave = autoSave;
return RestResponse("AutoSave has been set to " + autoSave); return RestResponse("AutoSave has been set to " + autoSave);
} }
[Description("Save the world.")]
[Route("/v2/world/save")]
[Permission(RestPermissions.restcfg)]
[Token]
private object WorldSave(RestRequestArgs args) private object WorldSave(RestRequestArgs args)
{ {
SaveManager.Instance.SaveWorld(); SaveManager.Instance.SaveWorld();
@ -668,6 +676,11 @@ namespace TShockAPI
return RestResponse("World saved"); return RestResponse("World saved");
} }
[Description("Butcher npcs.")]
[Route("/v2/world/butcher")]
[Permission(RestPermissions.restbutcher)]
[Noun("killfriendly", false, "Should friendly npcs be butchered.", typeof(bool))]
[Token]
private object WorldButcher(RestRequestArgs args) private object WorldButcher(RestRequestArgs args)
{ {
bool killFriendly; bool killFriendly;
@ -687,6 +700,9 @@ namespace TShockAPI
return RestResponse(killcount + " NPCs have been killed"); return RestResponse(killcount + " NPCs have been killed");
} }
[Description("Get information regarding the world.")]
[Route("/world/read")]
[Token]
private object WorldRead(RestRequestArgs args) private object WorldRead(RestRequestArgs args)
{ {
return new RestObject() return new RestObject()
@ -700,6 +716,10 @@ namespace TShockAPI
}; };
} }
[Description("Drops a meteor on the world.")]
[Route("/world/meteor")]
[Permission(RestPermissions.restcauseevents)]
[Token]
private object WorldMeteor(RestRequestArgs args) private object WorldMeteor(RestRequestArgs args)
{ {
if (null == WorldGen.genRand) if (null == WorldGen.genRand)
@ -708,10 +728,15 @@ namespace TShockAPI
return RestResponse("Meteor has been spawned"); return RestResponse("Meteor has been spawned");
} }
[Description("Toggle the status of blood moon.")]
[Route("/world/bloodmoon/{bloodmoon}")]
[Permission(RestPermissions.restcauseevents)]
[Verb("bloodmoon", "State of bloodmoon.", typeof(bool))]
[Token]
private object WorldBloodmoon(RestRequestArgs args) private object WorldBloodmoon(RestRequestArgs args)
{ {
bool bloodmoon; bool bloodmoon;
if (!bool.TryParse(args.Verbs["bool"], out bloodmoon)) if (!bool.TryParse(args.Verbs["bloodmoon"], out bloodmoon))
return RestInvalidParam("bloodmoon"); return RestInvalidParam("bloodmoon");
Main.bloodMoon = bloodmoon; Main.bloodMoon = bloodmoon;