Fungus Unity C Lua Skin
Fungus Unity C Lua 2

This page describes how to use Lua in your own scripts.

The PixelCrushers.DialogueSystem.DialogueLua class is the easiest way to access Lua data.

To get and set data in the standard Dialogue System Lua tables – Actor[], Item[], Location[] and Variable[] – use these methods:

The Dialogue System includes Lua functions that synchronize variables and quest states to all clients using Unity Networking's High Level API (UNET HLAPI). To make these functions available: Add this Scripting Define Symbol: USEUNET. Then add a Lua Network Commands component to. I'd suggest the latter solution. Make sure your colliders can actually collide. Go to 'Edit Project Settings Physics', scroll down until you see 'Layer Collision Matrix' and make sure the checkbox in the intersection of your objects' layers is checked. Make sure the two colliders can actually collide during play. Another challenge is how to handle events between Lua and Unity. I've been googling quite a bit but not having much success. How to do the following: From Lua: 1. Create events and attach Event listeners to Unity's GOs. When Unity GO's eventListener is triggered, fire the event handler function in Lua.

Method	Description	Example
`GetVariable()`	Get the value of a variable	`bool hasBox = DialogueLua.GetVariable('hasBox').AsBool`
`SetVariable()`	Set the value of a variable	`DialogueLua.SetVariable('hasBox', true);`
`GetActorField()`	Get the value of a field in an actor	`int xp = DialogueLua.GetActorField('Player', 'XP').AsInt;`
`SetActorField()`	Set the value of a field in an actor	`DialogueLua.SetActorField('Player', 'Intoxicated', true);`
`GetItemField()`	Get the value of a field in an item	`float weight = DialogueLua.GetItemField('Anvil', 'Weight');`
`SetItemField()`	Set the value of a field in an item	`DialogueLua.SetItemField('Anvil', 'Cost', 50);`
`GetQuestField()`	Get the value of a field in a quest. Equivalent to `GetItemField()`	`string state = DialogueLua.GetQuestField('Kill 5 Rats', 'State').AsString;`
`SetQuestField()`	Set the value of a field in a quest. Equivalent to `SetItemField()`	`DialogueLua.SetQuestField('Kill 5 Rats', 'State', 'success');`
`GetLocationField()`	Get the value of a field in a location	`string desc = DialogueLua.GetLocationField('Moonbase', 'Description');`
`SetLocationField()`	Set the value of a field in a location	`DialogueLua.SetLocationField('Moonbase', 'Description', 'A desolate lunar spaceport.');`

The DialogueLua class automatically converts table indices' spaces and hyphens to underscores. When using the DialogueLua class, you can ignore the note in Important Note About Table Indices. (However, when bypassing the DialogueLua class and using the Lua class directly, you must remember to convert spaces and hyphens to underscores.)

The DialogueLua.GetXXX() methods return a Lua.Result value. To get a basic data type, use properties such as AsString, AsInt, AsFloat, and AsBool. For example:

int age = DialogueLua.GetActorField('Player', 'Age').AsInt;

The Actor[], Item[], and Location[] tables are two-dimensional, meaning each element in the table has fields. Use the DialogueLua.GetXXXField() methods to access their fields.

The Variable[] table, on the other hand, is one-dimensional. The elements are regular data types (Boolean, string, number, etc.), so you cannot use the DialogueLua.GetXXXField() methods. Instead, use DialogueLua.GetVariable().

bool gotMilk = DialogueLua.GetVariable('Got Milk').AsBool;

Localization

To get the version of a field for the current language, use the localized versions of these methods:

Method	Description
`GetLocalizedActorField()`	Get the value of a localized field in an actor (e.g., 'Description es' for Spanish)
`SetLocalizedActorField()`	Set the value of a localized field in an actor
`GetLocalizedItemField()`	Get the value of a localized field in an item
`SetLocalizedItemField()`	Set the value of a localized field in an item
`GetLocalizedQuestField()`	Get the value of a localized field in a quest. Equivalent to `GetLocalizedItemField()`
`SetLocalizedQuestField()`	Set the value of a localized field in a quest. Equivalent to `SetLocalizedItemField()`
`GetLocalizedLocationField()`	Get the value of a localized field in a location
`SetLocalizedLocationField()`	Set the value of a localized field in a location

For example:

The PixelCrushers.DialogueSystem.Lua class provides lower-level access to the Lua environment through these functions:

Method	Description	Example
`Run()`	Run Lua code and return a Lua.Result structure	`int nextYear = Lua.Run('return Actor['Player'].Age + 1').AsInt;`
`IsTrue()`	Run Lua code and return `true` if the Lua result is true, otherwise false	`if (Lua.IsTrue('Actor['Player'].Age >= 21')) {...}`
`RegisterFunction()`	Register a C# method as a Lua function	`Lua.RegisterFunction('Exists', null, typeof(MyClass).GetMethod('Exists'));` (*see below)

Return Values

Remember that Lua.Run() returns a Lua.Result that can be a Boolean, string, number, or table. To get the Boolean value, you need to add '.AsBool', as in this example:

if (Lua.Run('return Variable['Kissed_the_Frog']').AsBool) {

}

Similarly, if your variable is a number, you can do this:

Fungus Unity C Lua Skin

int myCoins = Lua.Run('return Variable['numberOfCoins']').AsInt);

Since Lua.IsTrue() always returns a Boolean value (true or false), you don't need to add AsXXX to the end:

//(Player kissed the frog, so do something.)

Registering Functions

The RegisterFunction() method lets you tie your own C# code into the Lua environment. This is extremely handy to give your dialogue entry Conditions and Scripts new capabilities. (Use the corresponding UnregisterFunction() method to unregister the C# method from Lua.)

For example, say you want a dialogue entry to be available only when a certain GameObject named 'White Elephant' is in the scene. You want to be able to set the dialogue entry's Conditions field to this:

Conditions: GameObjectExists('White Elephant')

Simply add this class to your scene:

Lua.RegisterFunction('GameObjectExists', this, typeof(MyLuaFunctions).GetMethod('GameObjectExists'));

Lua.UnregisterFunction('GameObjectExists');

return GameObject.Find(name) != null;

}

Data Types Allowed in Lua Functions

IMPORTANT: C# methods registered with Lua must use double for numbers, not float or int.

Only use these types in your Lua functions' parameters and return values:

Type	Notes
`double`	LuaInterpreter uses doubles for all number types; you can cast to (int), (float), etc inside your function if necessary
`bool`	Use as normal
`string`	Use as normal