chariot.js/docs/assets/js/26.fd3fe405.js

An extremely lightweight and extensible Eris client framework

(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{213:function(t,e,s){"use strict";s.r(e);var a=s(0),n=Object(a.a)({},(function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("div",{staticClass:"content"},[t._m(0),t._v(" "),s("p",[t._v("Full API specification reference for using the built in Chariot.js Help system object within a "),s("router-link",{attrs:{to:"./../classes/command.html"}},[t._v("Chariot.Command")]),t._v(" class.")],1),t._v(" "),t._m(1),t._v(" "),s("div",{staticClass:"table"},[s("table",[t._m(2),t._v(" "),s("tbody",[s("tr",[t._m(3),t._v(" "),t._m(4),t._v(" "),s("td",[s("Fa-Check")],1),t._v(" "),s("td",[t._v('"Not Provided"')]),t._v(" "),s("td",[t._v("A help message explaining how to use the command")])]),t._v(" "),s("tr",[t._m(5),t._v(" "),t._m(6),t._v(" "),s("td",[s("Fa-Check")],1),t._v(" "),s("td",[t._v('"Not Provided"')]),t._v(" "),s("td",[t._v("A universal command usage template")])]),t._v(" "),s("tr",[t._m(7),t._v(" "),t._m(8),t._v(" "),s("td",[s("Fa-Check")],1),t._v(" "),s("td",[t._v('"Not Provided"')]),t._v(" "),s("td",[t._v("An array of specific command usage examples")])]),t._v(" "),s("tr",[t._m(9),t._v(" "),t._m(10),t._v(" "),s("td",[s("Fa-Check")],1),t._v(" "),s("td",[t._v("False")]),t._v(" "),s("td",[t._v("If the usage and examples should be inline")])]),t._v(" "),s("tr",[t._m(11),t._v(" "),t._m(12),t._v(" "),s("td",[s("Fa-Check")],1),t._v(" "),s("td",[t._v("True")]),t._v(" "),s("td",[t._v("If the command should be shown in the command list")])])])])]),t._v(" "),t._m(13),t._v(" "),s("p",[t._v("Example for a command echoing text")]),t._v(" "),t._m(14),s("p",[t._v("Example for a command hidden from the command list")]),t._v(" "),t._m(15)])}),[function(){var t=this.$createElement,e=this._self._c||t;return e("h1",{attrs:{id:"help-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#help-properties"}},[this._v("#")]),this._v(" Help Properties")])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[this._v("#")]),this._v(" Properties")])},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("thead",[s("tr",[s("th",[t._v("Parameter")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Optional")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("message")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("usage")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("example")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("String[]")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("inline")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("Boolean")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("code",[this._v("visible")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("td",[e("a",{attrs:{href:"#"}},[this._v("Boolean")])])},function(){var t=this.$createElement,e=this._self._c||t;return e("h2",{attrs:{id:"examples"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[this._v("#")]),this._v(" Examples")])},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("help "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    message"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'This command echoes the text provided as an argument in the channel'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    usage"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'echo <text>'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    example"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'echo Hello World!'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'echo This is an echo command, cool!'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    inline"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    visible"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])},function(){var t=this,e=t.$createElement,s=t._self._c||e;return s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("help "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    message"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'A super secret command hidden from the command list 🤫'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    usage"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'secret'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    example"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'secret'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    inline"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    visible"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])}],!1,null,null,null);e.default=n.exports}}]);