Scripting APIs

APIs in Vanda engine are functions that allow the user to perform certain tasks at runtime. You should use APIs inside scripting events. APIs are defined in the following general form:

return1, return2,..., returnN API_name(argunment1, argument2,...,argumentN)
An API may take the parameters argunment1argunment2,…,argumentN, performs an action, and returns the values return1return2,…, returnN if necessary. An API may take no input arguments and return no value. But in any case, it does something at runtime. Here are some examples:

Example 1

ActivateThirdPersonCamera()
This function takes no input arguments and returns no value, and only activates the third-person physics camera attached to the game’s main character.

Example 2

CreateFolder(string folderPath)
This function takes a string argument and creates a folder in the path “Assets/Data/folderPath”. This function does not return a value.

Example 3

bool IsWaterVisible(string waterName)
This function receives the name of the water as a string value and determines whether this water is visible or not. The result is returned as a Boolean value of true or false.

Example 4

double,double,double GetCharacterControllerPosition()
This function does not receive any input arguments and returns the X, Y and Z position of the character controller as three double values.
In this section, we explain the scripting functions available in Vanda engine.

A

C

D

E

G

H

I

L

O

P

R

S

T

U

W

adminScripting APIs