This lets your AI respond with special commands that your game can then understand and execute.

How it works

1. Defining Actions: You first define all the things your AI can do.
2. Instructions: You give your AI specific instructions and the provided instructions in the module.
3. Parsing: When the AI sends a message back, this module looks for those special action commands within the message.
4. Executing: The module can then run the corresponding functions you defined.

Actions

Actions are defined with:

local Actions = {
	-- Name of the action
	Test = {
		-- Detailed description of the action (So the AI can know what function it has access to)
		Description = 'This is a test function. Usage [Test {number}]',
		
		-- Actual function that fires
		Action = function(params, Context)
			print(Context.Name)
			print(params)
		end,
	},
}

Methods

• FunctionCaller.GetDescription(Actions: Actions): string

  • Returns a JSON string describing all available functions (those with a .Description field).

  • Parameters:

    • Actions

• FunctionCalling.Parse(RawResponse: string): (string, { [number]: { FunctionName: string, Params: string } })

  • Parses a raw AI or user-generated response string into:

    • A cleaned message (everything before the first action block).
    • A list of extracted actions in the format [FunctionName {params}].

  • Parameters:

    • RawResponse (string): The full input string, such as:
      • "Play sound [PlaySound {Explosion}]"

  • Returns:

    • playerMessage (string): The portion before any actions.
    • extractedActions (array): A list of tables with:
      • FunctionName (string)
      • Params (string)

• FunctionCalling.Execute(extractedActions, availableActions: Actions, context: { [any]: any })

  • Executes a list of parsed actions by looking them up in the provided Actions table.

  • Parameters

    • ExtractedActions: An array of actions returned from Parse, each with:
      • FunctionName: string
      • Params: string
    • Actions
    • Context (Optional): {any}
      • Any information the function needs.

  • Returns:

    • true, if all actions executed successfully.
    • false and the first error message encountered, if any action failed.

Properties

• FunctionCalling.FunctionCallingInstructions : string
  • Has instructions for function calling.