chariot.js/docs/assets/js/27.bdbad3e2.js

An extremely lightweight and extensible Eris client framework

(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{214:function(t,s,e){"use strict";e.r(s);var a=e(0),n=Object(a.a)({},(function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("div",{staticClass:"content"},[t._m(0),t._v(" "),e("p",[t._v("Locales used by Chariot.js for internal messages out of the box can be overriden using following Object strucutre.")]),t._v(" "),t._m(1),t._v(" "),t._m(2),t._v(" "),t._m(3),t._v(" "),e("div",{staticClass:"table"},[e("table",[t._m(4),t._v(" "),e("tbody",[e("tr",[t._m(5),t._v(" "),t._m(6),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),t._m(7),t._v(" "),e("td",[t._v("Message sent if the bot has missing or insufficient permissions.")])]),t._v(" "),e("tr",[t._m(8),t._v(" "),t._m(9),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),t._m(10),t._v(" "),e("td",[t._v("Embed object sent if the user has insufficient permissions.")])]),t._v(" "),e("tr",[t._m(11),t._v(" "),t._m(12),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),e("td",[t._v("No Variables")]),t._v(" "),e("td",[t._v("Message sent on illegal owner level command execution.")])]),t._v(" "),e("tr",[t._m(13),t._v(" "),t._m(14),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),t._m(15),t._v(" "),e("td",[t._v("Message sent if an NSFW command was used illegally.")])]),t._v(" "),e("tr",[t._m(16),t._v(" "),t._m(17),t._v(" "),e("td",[e("Fa-Check")],1),t._v(" "),t._m(18),t._v(" "),e("td",[t._v("Message sent if a command was run while on cooldown.")])])])])]),t._v(" "),t._m(19),t._v(" "),e("div",{attrs:{id:"properties"}},[e("h3",{attrs:{id:"missingpermissions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#missingpermissions"}},[t._v("#")]),t._v(" missingPermissions "),e("Badge",{attrs:{text:"Default Locale",type:"chariot"}})],1),t._v(" "),e("Fuckoff",[e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Can\'t run command **{command}** because I lack following permissions: **{missingPermissions}**"')]),t._v("\n")])])])]),t._v(" "),e("br"),t._v(" "),e("h3",{attrs:{id:"userpermissions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#userpermissions"}},[t._v("#")]),t._v(" userPermissions "),e("Badge",{attrs:{text:"Default Locale",type:"chariot"}})],1),t._v(" "),e("Fuckoff",[e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    title"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Insufficient Permissions!'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" \n    description"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'You lack following permissions to use this command: **{missingUserPermissions}**'")]),t._v(" \n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])]),t._v(" "),e("br"),t._v(" "),e("h3",{attrs:{id:"owner"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#owner"}},[t._v("#")]),t._v(" owner "),e("Badge",{attrs:{text:"Default Locale",type:"chariot"}})],1),t._v(" "),e("Fuckoff",[e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Insufficient permissions!"')]),t._v("\n")])])])]),t._v(" "),e("br"),t._v(" "),e("h3",{attrs:{id:"nsfw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#nsfw"}},[t._v("#")]),t._v(" nsfw "),e("Badge",{attrs:{text:"Default Locale",type:"chariot"}})],1),t._v(" "),e("Fuckoff",[e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Command **{command}** is only available in NSFW channels!"')]),t._v("\n")])])])]),t._v(" "),e("br"),t._v(" "),e("h3",{attrs:{id:"cooldown"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cooldown"}},[t._v("#")]),t._v(" cooldown "),e("Badge",{attrs:{text:"Default Locale",type:"chariot"}})],1),t._v(" "),e("Fuckoff",[e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Please wait **{timeLeftFormatted}** before using **{command}** again"')]),t._v("\n")])])])])],1),t._v(" "),t._m(20),t._v(" "),t._m(21),t._v(" "),t._m(22)])}),[function(){var t=this.$createElement,s=this._self._c||t;return s("h1",{attrs:{id:"locales"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#locales"}},[this._v("#")]),this._v(" Locales")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"data-injection"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#data-injection"}},[this._v("#")]),this._v(" Data Injection")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("Default variables provided internally by Chariot.js can be injected into custom strings as seen fit by using "),s("code",[this._v("{variableName}")]),this._v(" as a substitution string. The exact variable names used for data injection can be found down below.")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"properties"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[this._v("#")]),this._v(" Properties")])},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("thead",[e("tr",[e("th",[t._v("Parameter")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Optional")]),t._v(" "),e("th",[t._v("Variables")]),t._v(" "),e("th",[t._v("Description")])])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("missingPermissions")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("command")]),this._v(", "),s("br"),this._v(" "),s("br"),this._v(" "),s("code",[this._v("missingPermissions")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("userPermissions")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("Object")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("missingUserPermissions")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("owner")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("nsfw")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("command")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("cooldown")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("a",{attrs:{href:"#"}},[this._v("String")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("td",[s("code",[this._v("command")]),this._v(", "),s("br"),this._v(" "),s("br"),this._v(" "),s("code",[this._v("timeLeftFormatted")])])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"defaults"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[this._v("#")]),this._v(" Defaults")])},function(){var t=this.$createElement,s=this._self._c||t;return s("h2",{attrs:{id:"example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[this._v("#")]),this._v(" Example")])},function(){var t=this.$createElement,s=this._self._c||t;return s("p",[this._v("A pretty easy and straight forward "),s("code",[this._v("customLocales")]),this._v(" object could be structured as follows:")])},function(){var t=this,s=t.$createElement,e=t._self._c||s;return e("div",{staticClass:"language-js extra-class"},[e("pre",{pre:!0,attrs:{class:"language-js"}},[e("code",[e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ... */")]),t._v("\ncustomLocales"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    missingPermissions"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Command **{command}** requires following permissions: **{missingPermissions}**'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    owner"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'You should not be playing around with this!'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    cooldown"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Just wait **{timeLeftFormatted}** before spamming **{command}** yet again ...'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    nsfw"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'**{command}** is an NSFW command and cannot be used here.'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    userPermissions"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        title"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Hold up ...'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        description"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'I need you to make sure you have following permissions before using this command: **{missingUserPermissions}**'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ... */")]),t._v("\n")])])])}],!1,null,null,null);s.default=n.exports}}]);