Functions

In OSL, you can define custom functions to modularize and reuse your code. Functions can take multiple parameters, perform operations, and return results. These functions can be invoked with specific arguments and used throughout your script.

Defining a Custom Function

To define a custom function, use the def keyword followed by the function name and parameters. Declare local variables inside the function with any, auto, or another type keyword.

Example: Basic Arithmetic Function

Here's how you can create a function that performs basic arithmetic operations and returns a result:

def calculate(num1, num2, operation) (
  any result = null
  switch operation (
    case "add"
      result = num1 + num2
      break
    case "subtract"
      result = num1 - num2
      break
    case "multiply"
      result = num1 * num2
      break
    case "divide"
      result = num1 / num2
      break
  )
  return result
)

log calculate(10,5,"add")
// Outputs: 15
log calculate(10,5,"subtract")
// Outputs: 5
log calculate(10,5,"multiply")
// Outputs: 50
log calculate(10,5,"divide")
// Outputs: 2

Example: String Manipulation Function

You can also define functions to perform operations on strings. Here's an example of a function that reverses a string:

def reverseString(text) (
  string reversed = ""
  number i = text.len
  loop text.len (
    reversed ++= text[i]
    i --
  )
  return reversed
)

log reverseString("hello")  // Outputs: "olleh"

Example: Combining Functions

You can define helper functions and call them from other parts of your program:

def greet(name) (
  string message = "Hello, " ++ name ++ "!"
  return message
)

say greet("Alice")
// Outputs: "Hello, Alice!"

Example: Complex Data Processing

Custom functions can also handle complex data processing, such as filtering an array:

def filterEvenNumbers(nums) (
  array even = []
  for i nums.len (
    if nums[i] % 2 == 0 (
      even.append(nums[i])
    )
  )
  return even
)

data = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
log filterEvenNumbers(data)  // Outputs: [2, 4, 6, 8, 10]

// or you can use .filter()
log data.filter(num -> (num % 2 == 0))  // Outputs: [2, 4, 6, 8, 10]

Functions are Stored As Variables

Whenever you define a function, it is stored as a variable, the same way that Inlinefunctions are stored.

def myfunc() (

)

log myfunc
// logs the function object

This means you can assign a function to another variable and call it through the new name:

def myfunc() (
  return 10
)

myNewFunc = myfunc

log myNewFunc()
// logs 10