Skip to content

Commit

Permalink
Update command meta for cooldown, add command meta for define.
Browse files Browse the repository at this point in the history
  • Loading branch information
aufdemrand committed Aug 25, 2013
1 parent 5eae01b commit f08af60
Showing 1 changed file with 48 additions and 16 deletions.
Expand Up @@ -301,7 +301,7 @@ public void registerCoreMembers() {

// <--[command]
// @Name cooldown
// @Usage cooldown (duration:<value>) (global) (script:<name>)
// @Usage cooldown [<duration>] (global) (s:<script>)
// @Required 1
// @Stable Stable
// @Short Temporarily disables a script-container from meeting requirements.
Expand Down Expand Up @@ -337,9 +337,9 @@ public void registerCoreMembers() {
// @Example
//
// -->

registerCoreMember(CooldownCommand.class,
"COOLDOWN", "cooldown (duration:<value>) (global) (script:<name>)", 1);
"COOLDOWN", "cooldown [<duration>] (global) (s:<script>)", 1);


// <--[command]
// @Name copyblock
Expand All @@ -360,6 +360,7 @@ public void registerCoreMembers() {
registerCoreMember(CopyBlockCommand.class,
"COPYBLOCK", "copyblock [location:<location>] [to:<location>]", 1);


// <--[command]
// @Name createworld
// @Usage createworld [<name>] (g:<generator>)
Expand All @@ -379,25 +380,56 @@ public void registerCoreMembers() {
registerCoreMember(CreateWorldCommand.class,
"CREATEWORLD", "createworld [<name>] (g:<generator>)", 1);


// <--[command]
// @Name define
// @Usage define [<id>] [<value>]
// @Required 2
// @Stable Todo
// @Short Todo
// @Author Todo
// @Description
// Todo
// @Tags
// Todo
// @Usage
// Todo
// @Example
// Todo
// -->
// @Stable 1.0
// @Short Creates a temporary variable inside a script queue.
// @Author aufdemrand
//
// @Description
// Definitions are queue-level (or script-level) 'variables' that can be used throughout a script, once
// defined, by using %'s around the definition id/name. Definitions are only valid on the current queue and are
// not transferred to any new queues constructed within the script, such as a 'run' command, without explicitly
// specifying to do so.
//
// Definitions are lighter and faster than creating a temporary flag, but unlike flags, are only a single entry,
// that is, you can't add or remove from the definition, but you can re-create it if you wish to specify a new
// value. Definitions are also automatically destroyed when the queue is completed, so there is no worry for
// leaving unused data hanging around.
//
// Definitions are also resolved before replaceable tags, meaning you can use them within tags, even as an
// attribute. ie. <%player%.name>
//
// @Usage
// Use to make complex tags look less complex, and scripts more readable.
// - narrate 'You invoke your power of notice...'
// - define range '<player.flag[range_level].mul[3]>'
// - define blocks '<player.flag[noticeable_blocks>'
// - narrate '[NOTICE] You have noticed <player.location.find.blocks[%blocks%].within[%range].size>
// blocks in the area that may be of interest.'
//
// @Usage
// Use to keep the value of a replaceable tag that you might use many times within a single script. Definitions
// can be faster and cleaner than reusing a replaceable tag over and over.
// - define arg1 <c.args.get[1]>
// - if %arg1% == hello narrate 'Hello!'
// - if %arg1% == goodbye narrate 'Goodbye!'
//
// @Usage
// Use to pass some important information (arguments) on to another queue.
// - run 'new_task' d:hello|world
// 'new_task' now has some definitions, %1% and %2%, that contains the contents specified, 'hello' and 'world'.
//
// @Example
//
// -->
registerCoreMember(DefineCommand.class,
"DEFINE", "define [<id>] [<value>]", 2);



// <--[command]
// @Name determine
// @Usage determine [<value>]
Expand Down

0 comments on commit f08af60

Please sign in to comment.