Functions

Functions are underappreciated. In general, not just in templates. // Rob Pike ; Learning without thought is labor lost; thought without learning is perilous. // Confucius

Preface

Functions are useful in custom commands. There are several kinds of functions in YAGPDB "engine", such as Type Conversion, String Manipulation, Math Functions, Message Functions, Mentions, Role Functions, Current User, and Miscellaneous Functions.

Also, there are more functions like database, Conditional Branching, Range Action, and With Action, all of which can be made into very different commands. Therefore, those functions should not be underappreciated. We should pay more attention in this part.

Preview

Before actually entering to the world of functions, let's try to read the codes here.

Do you understand the codes? This combination of commands contains many kinds of functions like Type Conversion, String Manipulation, Math Functions, Message Functions, and other functions.

The following is a command for a small lottery. First, It will send a message with a ping of a role to a specific channel when the lottery is going to be drawn. Second, it will use math functions and string manipulation to generate the 5 winning numbers respectively. Third, it will check if the user's number is correct and save the mentions of the winners into a variable. Last, it will send the result to a channel where the starting message was sent.

Command type: Hourly Interval

{{$msgID := sendMessageNoEscapeRetID 699896915202015232 "<@&701426374048612422>. The lottery is now starting to be drawn!"}}
{{sleep 30}}
{{$allnum := "01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49"}}
{{$rand := ""}}{{$num := ""}}
{{range (seq 1 6)}}
	{{$rand = (randInt 1 (div (add (toInt (len $allnum)) 4) 3))}}
	{{$del := ""}}{{$int := ""}}
	{{if eq $rand 1}}
		{{$int = (joinStr "" (slice $allnum 0 2))}}
		{{$del = (joinStr "" $int " ")}}
	{{else if eq $rand (div (add (toInt (len $allnum)) 1) 3)}}
		{{$int = (joinStr "" (slice $allnum (mult 3 (sub $rand 1)) (sub (mult 3 $rand) 1)))}}
		{{$del = (joinStr "" " " $int)}}
	{{else}}
		{{$int = (joinStr "" (slice $allnum (mult 3 (sub $rand 1)) (sub (mult 3 $rand) 1)))}}
		{{$del = (joinStr "" $int " ")}}
	{{end}}
	{{$num = (joinStr " " $num $int)}}
	{{editMessage 699896915202015232 $msgID (joinStr " " "The number is...." $num)}}
	{{$rand = (toString $rand)}}
	{{$allnum = (reReplace $del $allnum "")}}
	{{sleep 2}}
{{end}}
{{$digits := reFindAll "[0-9]+" $num}}
{{$n1 := (index $digits 0)}} {{$n2 := (index $digits 1)}} {{$n3 := (index $digits 2)}} {{$n4 := (index $digits 3)}} {{$n5 := (index $digits 4)}}
{{$winner := ""}}
{{range (dbTopEntries "lottery" 100 0)}}
	{{$value := .Value}}
	{{if eq $value $n1 $n2 $n3 $n4 $n5}}
		{{$winner = (joinStr "" $winner "\n" .User.Mention " is correct.")}}
		{{$userID := .User.ID}}
		{{with (toInt (dbGet $userID "lotterywintime").Value)}}
			{{dbSet $userID "lotterywintime" (add 1 .)}}
		{{else}}
			{{dbSet $userID "lotterywintime" 1}}
		{{end}}
	{{end}}
{{end}}
{{if $winner}}
	{{sendMessage 639892390907346975 "The lottery has been drawn. Congratulation for the winners."}}
	{{sendMessage 639892390907346975 (joinStr "" $winner)}}
{{else}}
	{{sendMessage 639892390907346975 "No one won the lottery this time. What a pity!"}}
{{end}}

Guidance

• Try to tell the first, the second, the third, and the last part of the command.

• Try to find all of the parts that need an end after the function.

• If you have read the contents here, you may be able to read the codes.

Functions won't be hard so long as you actually understand the usage of them. Therefore, reading the examples and try to understand them is recommended.