Field

Description

.CCID

The ID of currently executing custom command in type of int64.

.IsPremium

Returns boolean true/false whether guild is premium of YAGPDB or not.

Field

Description

.User

The user's username together with discriminator.

.User.String

The user's username together with discriminator as string-type.

.User.Username

The user's username.

.User.ID

The user's ID.

.User.Discriminator

The user's discriminator (The four digits after a person's username).

.User.Avatar

The user's avatar ID.

.User.AvatarURL "256"

Gives the URL for user's avatar, argument "256" is the size of the picture and can increase/decrease twofold (e.g. 512, 1024 or 128, 64 etc.).

.User.Bot

Determines whether the target user is a bot - if yes, it will return True.

.User.Mention

Mentions user.

.RealUsername

Only works with join and leave messages (not join dms). This can be used to send the real username to a staff channel when invites are censored.

.UsernameHasInvite

Only works with join and leave messages (not join dms). It will determine does the username contain an invite link.

Function

Description

userArg mention/userID

Function that can be used to retrieve .User object from a mention or userID.

{{ (userArg .User.ID).Mention }} mentions triggering user.

pastUsernames userID offset

Returns a slice of type [ ]*logs.CCNameChange having fields .Name and .Time of previous 15 usernames and skips offset number in that list.

{{ range pastUsernames .User.ID 0 }} {{ .Name }} - {{ .Time.Format "Jan _2 2006" }} {{ end }}

pastNicknames userID offset

Same as pastUsernames.

Field

Description

.Guild.ID

Outputs the ID of the guild.

.Guild.Name

Outputs the name of the guild.

.Guild.Icon

Outputs the ID of the guild's icon.

.Guild.Region

Outputs the region of the guild.

.Guild.AfkChannelID

Outputs the AFK channel ID.

.Guild.OwnerID

Outputs the ID of the owner.

.Guild.JoinedAt

Outputs the timestamp when YAGPDB joined the guild. To convert it to type Time, use .Parse method > .Guild.JoinedAt.Parse

.Guild.AfkTimeout

Outputs the time when a user gets moved into the AFK channel while not being active.

.Guild.MemberCount

Outputs the number of users on a guild.

.Guild.VerificationLevel

Outputs the required verification level for the guild.

.Guild.EmbedEnabled

Outputs whether guild is embeddable (e.g. widget) or not, true / false.

.Guild.Roles

Outputs all roles and indexing them gives more information about the role. For exampe {{ len .Server.Roles }} gives you how many roles are there in that guild.

Field

Description

.Member.JoinedAt

When member joined the guild/server of type Timestamp. .Parse method will convert this to of type Time.

.Member.Nick

The nickname for this member.

.Member.Roles

A list of role IDs that the member has.

.Member.User

Underlying user on which the member is based on.

Function

Description

editNickname "newNick"

Edits triggering user's nickname, argument has to be of type string. YAGPDB must be above the roles user's having.

getMember

Function returns Member object having above methods.

{{ (getMember .User.ID).JoinedAt }} is the same as {{ .Member.JoinedAt }}

onlineCount

Returns the count of online users/members on current server.

onlineCountBots

Returns the count of online bots.

Field

Description

.Channel.Name

The Name of the channel.

.Channel.ID

The ID of the channel.

.Channel.ParentID

The ID of the channel's parent (category), returns 0 if none.

.Channel.Topic

The Topic of the channel.

.Channel.NSFW

Outputs whether this channel is NSFW or not.

Function

Description

editChannelName channel "newName"

Function edits channel's name. channel can be either ID, "name" or even nil if triggered in that channel name change is intended to happen. "newName" has to be of type string. For example >{{ editChannelName nil (joinStr "" "YAG - " (randInt 1000) ) }}

editChannelTopic channel "newTopic"

Function edits channel's topic/description. channel can be either ID, "name" or even nil if triggered in that channel name change is intended to happen. "newTopic" has to be of type string. For example >

{{ editChannelTopic nil "YAG is cool" }}

getChannel channel

Function returns full channel object of given channel argument which can be either it's ID, name or nil for triggering channel, and is of type *dstate.ChannelState. For example > {{ (getChannel nil).Name }} returns the name of the channel command was triggered in.

Field

Description

.Message.ID

ID of the message.

.Message.ChannelID

Channel id this message is in.

.Message.Author

Author of the message (User object).

.Message.Timestamp

Timestamp of the message in type timestamp (use .Message.Timestamp.Parse to get type time and .Parse.String method returns type string).

.Message.Attachments

Attachments to this message (slice of attachment objects).

.Message.Embeds

Embeds on this message (slice of embed objects).

.Message.Mentions

Users this message mentions.

.Message.Reactions

Reactions on this message (only available from getMessage).

.Message.Content

Text content on this message.

.Args

List of everything that is passed to .Message.Content. .Args is a slice of type string.

.Cmd

.Cmd is of type string and shows all arguments that trigger custom command, part of .Args. Starting from {{ index .Args 0 }}.

.CmdArgs

List of all the arguments passed after .Cmd (.Cmd is the actual trigger) .CmdArgs is a slice of type string. Examples in misc. snippets.

.StrippedMsg

"Strips" or cuts off the triggering part of the message and prints out everything else after that. Bare in mind, when using regex as trigger, for example "day" and input message is "Have a nice day my dear YAG!" output will be "my dear YAG!" - rest is cut off.

Field

Description

.Reaction

Returns reaction object which has following fields UserID, MessageID, Emoji.(ID/Name/...), ChannelID, GuildID. Emoji.ID is the ID of the emoji for custom emojis, and Emoji.Name will hold the unicode emoji if its a default one. (otherwise the name of the custom emoji).

.ReactionMessage

Returns the message object reaction was added to.

{{ range .ReactionMessage.Reactions }} {{ .Count }} - {{ .Emoji.Name }} {{ end }}

Returns emoji count and their name.

.ReactionAdded

Returns a boolean true/false indicating whether reaction was added or removed.

Field

Description

.TimeHour

Variable of time.Duration type and returns 1 hour > 1h0m0s.

.TimeMinute

Variable of time.Duration type and returns 1 minute > 1m0s.

.TimeSecond

Variable of time.Duration type and returns 1 second > 1s.

Function

Description

currentTime

Gets the current time, value is of type time; which can be used in a custom embed. More info here.

formatTime Time "arg"

Outputs given time in RFC822 formatting, first argument Time shows it needs to be of type time, also with extra layout if second argument is given - e.g. {{ formatTime currentUserCreated "3:04PM" }} would output 11:22AM if that would have been user's creating time.

humanizeDurationHours

Returns nanoseconds argument of type int64 in human readable format - as how long it would take to get towards given time - e.g. {{ humanizeDurationHours 9000000000000000000 }} returns 285 years 20 weeks 6 days and 16 hours. More in snippets.

humanizeDurationMinutes

Sames as humanizeDurationHours, this time duration is given in minutes - e.g. {{ humanizeDurationMinutes 3500000000000 }} would return 58 minutes.

humanizeDurationSeconds

Sames as both humanize functions above, this time duration is given in seconds - e.g. {{ humanizeDurationSeconds 3500000000000 }} would return 58 minutes and 20 seconds.

humanizeTimeSinceDays

Returns time has passed since given argument of type Time in human readable format - e.g. {{ humanizeTimeSinceDays currentUserCreated }}

newDate year month day hour minute second

Returns new time object in UTC using following syntax... all arguments need to be of type int, for example > {{ humanizeDurationHours ( (newDate 2059 1 2 12 34 56).Sub currentTime) }} will give you how much time till year 2059 January 2nd 12:34:56. More examples in snippets.

Function

Description

toString

Converts something into a string. Usage: (toString x).

toInt

Converts something into an integer. Usage: (toInt x).

toInt64

Converts something into an int64. Usage: (toInt64 x).

toFloat

Converts argument (number or string form of a number) to type float64. Usage: (toFloat x).

toDuration

Converts the argument, number or string to type Duration. Number represents nanoseconds. String can be with time modifier (second, minute, hour, day etc) s, m, h, d, w, mo, y,without a modifier string will be converted to minutes. Usage:(toDuration x). Example in section's Snippets.

json value

Traverses given value through MarshalJSON (more here) and returns it as type string. For example {{ json .TimeHour }} outputs type string; before this .TimeHour was of type time.Duration. Basically it's good to use if multistep type conversion is needed (toString (toInt value) ) and certain parts of cembed need this for example.

Function

Description

joinStr "separator" "str1" (arg1)(arg2) "str2" ...

Joins several strings into one, separated by the first arg"separator", useful for executing commands in templates (e.g.{{joinStr "" "1" "2" "3"}} returns 123).

lower "string"

Converts the string to lowercase.

upper "string"

Converts the string to uppercase.

slice "string" integer (integer2)

Outputs the "string" after cutting/slicing off integer (numeric) value of symbols (actually starting the string's index from integer through integer2) - e.g. {{slice "Fox runs" 2}}outputs x runs. When using also integer2 - e.g. {{slice "Fox runs" 1 7 }}, it outputs ox run. For slicing whole words, see example in section's Snippets.

​

slice function is not the same as basic dynamically-sized slice data type discussed in this reference doc.

urlescape "string"

Escapes the string so it can be safely placed inside a URL path segment - e.g. "Hello, YAGPDB!" becomes "Hello%2C%20YAGPDB%21"

split "string" "sepr"

Splits given "string" to substrings separated by "sepr"arg and returns new slice of the substrings between given separator e.g. {{ split "YAG, is cool!" "," }} returns [YAG is cool!] slice where YAG is at index 0 and is cool! at index 1. Example also in section's Snippets.

title "string"

Returns string with the first letter of each word capitalized.

reFind "regex" "string"

Compares string to regex pattern and returns first match. {{ reFind "AG" "YAGPDB is cool!" }}returns AG (regex pattern is case sensitive).

reFindAll "regex" "string"

Adds all regex matches from the string to a slice. Example in section's Snippets.

reFindAllSubmatches "regex" "string"

Returns whole-pattern matches and also the sub-matches within those matches as slices inside a slice. {{ reFindAllSubmatches "(?i)y([a-z]+)g" "youngish YAGPDB" }} returns [[young oun] [YAG A]] (regex pattern here is case insensitive).

reReplace "regex" "string1" "string2"

Replaces string1 contents with string2 at regex match point. {{ reReplace "I am" "I am cool!" "YAGPDB is" }}returns YAGPDB is cool! (regex pattern here is case sensitive).

Function

Description

add x y z ...

Returns x + y + z + ..., detects first number type; is it integer or float and based on that adds. (use toFloat on the first argument to force floating point math.){{ add 5 4 3 2 -1 }} sums all these numbers and returns 13.

sub x y z ...

Returns x - y -z - ... Works like add, just subtracts.

mult x y z ...

Multiplication, like add or div, detects first number type. {{ mult 3.14 2 }} returns 6.28

div x y z ...

Division, like add or mult, detects number type first. {{ div 11 3 }} returns 3 whereas {{ div 11.1 3 }} returns 3.6999999999999997

fdiv x y z ...

Meant specifically for floating point numbers division.

mod x y

Mod returns the floating-point remainder of x/y. mod 17 3 returns 2 of type float64.

randInt (stop, or start stop)

Returns a random integer between 0 and stop, or start - stop if two args are provided.

Result will be start <= random number < stop. Example in section's Snippets.

round

Returns the nearest integer, rounding half away from zero. Regular rounding > 10.4 is 10 and 10.5 is 11. All round functions return type float64, so use conversion functions to get integers. For more complex rounding, example in section's Snippets.

roundCeil

Returns the least integer value greater than or equal to input or rounds up. {{ roundCeil 1.1 }} returns 2.

roundFloor

Returns the greatest integer value less than or equal to input or rounds down. {{ roundFloor 1.9 }} returns 1.

roundEven

Returns the nearest integer, rounding ties to even. {{ roundEven 10.5 }} returns 10 {{ roundEven 11.5 }} returns 12.

sqrt

Returns the square root of a number as type float64. {{ sqrt 49 }} returns 7, {{ sqrt 12.34 | printf "%.4f" }} returns 3.5128

Function

Description

sendDM "message here"

Sends the user a direct message, only one DM can be sent per template (accepts embed objects). random adjective.

sendMessage channel message

Sends message (string or embed) in channel, channel can be either nil, the channel ID or the channel's "name".

sendMessageRetID channel message

Same as sendMessage, but also returns messageID to assigned variable for later use. Example in section's Snippets.

sendMessageNoEscape channel message

Sends message (string or embed) in channel, channel can be either nil, the channel ID or the channel "name". Doesn't escape mentions (e.g. role mentions or @here/@everyone).

sendMessageNoEscapeRetID channel message

Same as sendMessageNoEscape, but also returns messageID to assigned variable for later use.

editMessage channel messageID newMessageContent

Edits the message in channel, channel can be either nil, channel's ID or "name". Light example in section's Snippets.

editMessageNoEscape channel messageID newMessageContent

Edits the message in channel and has same logic in escaping characters as sendMessageNoEscape.

getMessage channelID messageID

Returns a Message object.

deleteResponse time

Deletes the response after a certain time (max 86400 seconds).

deleteTrigger time

Deletes the trigger after a certain time (max 86400 seconds).

deleteMessage channel messageID (delay)

Deletes message with given messageID from channel. Channel can be either nil, channelID or channel's name. (Delay) is optional and like previous two delete functions, it defaults to 10 seconds, max being 1 day. Example in section's Snippets.

addReactions "👍" "👎" ...

Adds each emoji as a reaction to the message that triggered the command (recognizes Unicode emojis and emojiname:emojiid).

addResponseReactions "👍" "👎" ...

Adds each emoji as a reaction to the response message (recognizes Unicode emojis and emojiname:emojiid).

addMessageReactions channel messageID reactions

Same as addReactions or addResponseReactions, but can be used on any messages using its ID. Channel can be either nil, channelID or channel's name. Example in section's Snippets.

deleteAllMessageReactions channel messageID

Deletes all reactions pointed message has. channel can be ID, "name" or nil.

Function

Description

mentionEveryone

Mentions @everyone.

mentionHere

Mentions @here.

mentionRoleName "rolename"

Mentions the first role found with the provided name (case-insensitive).

mentionRoleID roleID

Mentions the role found with the provided ID.

escapeEveryone "input"

Escapes everyone mentions in a string.

escapeHere "input"

Escapes here mentions in a string.

escapeEveryoneHere "input"

Escapes everyone and here mentions in a string. Useful with sendMessageNoEscape, also applies to escapeEveryone/Here. Example in section's Snippets.

Function

Description

hasRoleName "rolename"

Returns true if the user has the role with the specified name (case-insensitive).

hasRoleID roleID

Returns true if the user has the role with the specified ID (use the listroles command for a list of roles).

addRoleID roleID

Adds the role with the given ID to the user that triggered the command (use the listroles command for a list of roles).

removeRoleID roleID (delay)

Removes the role with the given ID from the user that triggered the command (use the listroles command for a list of roles). Delay is optional argument in seconds.

giveRoleID userID roleID

Gives a role by ID to the target.

giveRoleName userID "roleName"

Gives a role by name to the target.

takeRoleID userID roleID (delay)

Takes away a role by ID from the target. Delay is optional argument in seconds.

takeRoleName userID "roleName" (delay)

Takes away a role by name from the target. Delay is optional argument in seconds.

targetHasRoleID userID roleID

Returns true if the given user has the role with the specified ID (use the listroles command for a list of roles). Example in section's Snippets.

targetHasRoleName userID "roleName"

Returns true if the given user has the role with the specified name (case-insensitive).

Function

Description

currentUserCreated

Returns value of type time and shows when the current user was created.

currentUserAgeHuman

The account age of the current user in more human readable format (Eg:3 days 2 hours).

currentUserAgeMinutes

The account age of the current user in minutes.

Function

Description

adjective

Returns a random adjective.

range slice/array

Iterates (loops) over the given slice or array and sets successive elements as active data (the dot) to be further handled inside the range template. Example usage here. More in-depth here.

dict key1 value1 key2 value2 ...

Creates an unordered collection of key-value pairs, a dictionary so to say. The number of parameters to form key-value pairs must be even.

sdict "key1" "value1" "key2" "value2" ...

The same as dict but with only string keys and can be used in cembed. Has.Get "key", .Del "key" and Set "key" "value" methods that'll allow to capture. delete or change value's content for given key. Example on using those methods in Snippets.

cslice value1 value2 ...

Creates a slice (similar to array) that can be used elsewhere (cembed and sdict for example).

cembed "list of embed values"

Function to generate embed inside custom command. More in-depth here.

in list value

Returns boolean true/false whether case-sensitive value is in list/slice. {{ in (cslice "YAGPDB" "is cool") "yagpdb" }} returns false.

inFold

Same as in, but is case-insensitive. {{ inFold (cslice "YAGPDB" "is cool") "yagpdb" }} returns true.

seq start stop

Creates a new slice of type integer, beginning from start number, increasing in sequence and ending at stop (not included). {{ seq -4 2 }} returns a slice [ -4 -3 -2 0 1 ]. Sequence's max length is 10 000.

shuffle list

Returns a shuffled, randomized version of a list/slice.

exec "command" "args" "args" "args" ...

Executes a YAGPDB command (e.g. reverse, roll, kick etc) in a custom command. Exec can be run max 5 times per command. If real command returns an embed - exec will return raw data of type embed, so you can use embed fields for better formatting - e.g. {{ $resp := exec "whois" }} {{ $resp.Title }} Joined at > {{ (index $resp.Fields 4).Value }} will return the title (username#discriminator) and "Joined at" field's value from whois command.

execAdmin "command" "args" "args" "args" ...

Functions same way as exec but will override any permission requirement (such as the kick permission to use kick command etc.).

parseArgs required_args error_message ...carg

Checks the arguments for a specific type. More in depth here and an example in Custom Command Examples.​

carg "type" "name"

Defines type of argument for parseArgs. More in depth here and an example in Custom Command Examples.​

sleep seconds

Pauses execution of template inside custom command for max 60 seconds combined. Argumentsecondsis of type integer. Example in Snippets.

Function

Description

execCC ccID channel delay data

Function that executes another custom command specified by ccID,max recursion depth is 2 (using .StackDepth shows the current depth) and it's rate-limited strictly at max 10 delayed custom commands executed per channel per minute, if you go over that it will be simply thrown away. Argument channel can be nil, channel's ID or name. Thedelay argument is execution delay of another CC is in seconds. The data argument is content that you pass to the other executed custom command. To retrieve that data you use .ExecData. This example is important - execCC example also this snippet which shows you same thing run using the same custom command > Snippets.

scheduleUniqueCC ccID channel delay key data

Same as execCCexcept there can only be 1 scheduled cc execution per server per key, if key already exists then it is overwritten with the new data and delay.

An example would be a mute command that schedules unmute in the future, but if you use the mute command again on the same user you dont want to schedule another unmute, you wanna overwrite the next unmute event to the new time, which is what this does.

cancelScheduledUniqueCC ccID key

Cancels a previously scheduled custom command execution using scheduleUniqueCC

Function

Description

dbSet userID key value

Sets the value for the specified key for the specific userID to the specified value. userID can be any number of type int64. Values are stored either as of type float64 (for numbers or hex) or as varying type in bytes (for slices, maps, strings etc) depending on input argument.

dbSetExpire userID key value ttl

Same as dbSet but with an expiration in seconds (Note: This does not work with dbIncr atm).

dbIncr userID key incrBy

Increments the value for specified key for the specified user, if there was no value then it will be set to incrBy . Also returns the entry's current, increased value.

dbGet userID key

Retrieves a value from the database for the specified user, this returns DBEntry object.

dbGetPattern userID pattern amount nSkip

Retrieves up toamount (max 100)entries from the database in ascending order.

dbGetPatternReverse userID pattern amount nSkip

Retrievesamount (max 100)entries from the database in descending order.

dbDel userID key

Deletes the specified key for the specified value from the database.

dbDelByID userID ID

Deletes database entry by it's ID.

dbTopEntries pattern amount nSkip

Returns amount (max 100)top entries from the database, sorted by the value in a descending order.

dbBottomEntries pattern amount nSkip

Returns amount (max 100)top entries from the database, sorted by the value in a ascending order.

dbCount (userID|key)

Returns the count of all database entries which are not expired. Optional arguments: if userID is given, counts entries for that userID or if key, then only those keys are counted.

Fields

Description

ID

ID of the entry.

GuildID

ID of the server.

UserID

ID of the user.

CreatedAt

When this entry was created.

UpdatedAt

When this entry was last updated.

ExpiresAt

When entry will expire.

Key

The key of the entry.

Value

The value of the entry.

Case

Example

if

{{ if (condition) }} output {{ end }}

Initialization statement can also be inside if statement with conditional statement, limiting the initialized scope to that if statement. {{ $x := 24 }} {{ if eq ($x := 42) 42 }} Inside: {{ $x }} {{ end }} Outside: {{ $x }}

else if

{{ if (condition) }} output1 {{ else if (condition) }} output2 {{ end }}

You can have as manyelse ifstatements as many different conditionals you have.

else

{{ if (condition) }} output1 {{ else }} output2 {{ end }}

not

{{ if not (condition) }} output {{ end }}

and

{{ if and (cond1) (cond2) (cond3) }} output {{ end }}

or

{{ if or (cond1) (cond2) (cond3) }} output {{ end }}

Equal: eq

{{ if eq .Channel.ID ######## }} output {{ end }}

Not equal: ne

{{ $x := 7 }} {{ $y := 8 }} {{ ne $x $y }} returns true

Less than: lt

{{ if lt (len .Args) 5 }} output {{ end }}

Less than or equal: le

{{ $x := 7 }} {{ $y := 8 }} {{ le $x $y }} returns true

Greater than: gt

{{ if gt (len .Args) 1 }} output {{ end }}

Greater than or equal: ge

{{ $x := 7 }} {{ $y := 8 }} {{ ge $x $y }} returns false