|
| 1 | +--- |
| 2 | +title: "Functions" |
| 3 | +draft: false |
| 4 | +toc: true |
| 5 | +--- |
| 6 | + |
| 7 | +## Arguments |
| 8 | + |
| 9 | +Functions can have multiple input arguments. |
| 10 | + |
| 11 | +Functions can also have multiple output arguments. |
| 12 | + |
| 13 | + |
| 14 | +## Definitions |
| 15 | + |
| 16 | +<details> |
| 17 | + <summary>Nodes</summary> |
| 18 | + |
| 19 | +</details> |
| 20 | + |
| 21 | +<details> |
| 22 | + <summary>Code</summary> |
| 23 | + |
| 24 | + ```ruby |
| 25 | + FillZero(U32 color) {} # An argument value |
| 26 | + FillOne(U32 size, U32 color = 0) {} # Multiple argument values |
| 27 | + FillTwo() -> Bool {} # A return value |
| 28 | + FillThree() -> Bool, S32 { # Multiple return values |
| 29 | + return true, 2; |
| 30 | + } |
| 31 | + FillFour() -> Bool valid, S32 count { # Multiple named return values |
| 32 | + valid = true; |
| 33 | + count = 2; # All named values without a default must be assigned before return. |
| 34 | + } |
| 35 | + |
| 36 | + FillFive(U32 color = 0) {} # Default argument values |
| 37 | + FillSix(U32 color) -> Bool=false {} # Default return values |
| 38 | + FillSeven() -> Bool=true, S32=undefined {} # Multiple return values with defaults |
| 39 | + FillEight() -> Bool valid=true, S32 count {} # Named returns with defaults |
| 40 | + ``` |
| 41 | +</details> |
| 42 | + |
| 43 | + |
| 44 | +## Calls |
| 45 | + |
| 46 | +<details> |
| 47 | + <summary>Nodes</summary> |
| 48 | + |
| 49 | +</details> |
| 50 | + |
| 51 | +<details> |
| 52 | + <summary>Code</summary> |
| 53 | + |
| 54 | + ```ruby |
| 55 | + FillZero(); # Error, argument must be provided |
| 56 | + FillZero(0); |
| 57 | + FillOne(0); # color is set by default to 0 |
| 58 | + FillOne(0, 0); |
| 59 | + FillOne(size = 1); # Set an argument by name |
| 60 | + FillOne(0, color = 1); |
| 61 | + FillOne(size = 1, 0); # ERROR: Named arguments must be at the end of the called function. |
| 62 | + FillOne(color = 0, size = 1); # Set multiple arguments by name |
| 63 | + |
| 64 | + Bool result = FillTwo(); |
| 65 | + [Bool result, S32 count] = FillThree(); # Define and assign returns |
| 66 | + |
| 67 | + Bool result; S32 count; |
| 68 | + [result, count] = FillThree(); # Assigning a value to existing variables |
| 69 | + [result, count] = FillFour(); # Named return values are returned in order |
| 70 | + |
| 71 | + [result, count] = FillThree(); # Named return values are returned in order |
| 72 | + ``` |
| 73 | +</details> |
| 74 | + |
| 75 | + |
| 76 | +## Member Functions |
| 77 | + |
| 78 | +<details> |
| 79 | + <summary>Nodes</summary> |
| 80 | + |
| 81 | +</details> |
| 82 | + |
| 83 | +<details> |
| 84 | + <summary>Code</summary> |
| 85 | + |
| 86 | + ```ruby |
| 87 | + Type one; |
| 88 | + one.DoSomething(); |
| 89 | + |
| 90 | + Type* ptr = &one; |
| 91 | + ptr->DoSomething(); |
| 92 | + ``` |
| 93 | +</details> |
| 94 | + |
| 95 | + |
| 96 | +## Properties |
| 97 | + |
| 98 | +Functions can be marked with different properties to change their behavior. |
0 commit comments