PixelCrushers.DialogueSystem.plyGame.plyGameBridge Class Reference

This script provides a bridge between plyGame data and the Dialogue System's Lua environment. More...

Inheritance diagram for PixelCrushers.DialogueSystem.plyGame.plyGameBridge:

Collaboration diagram for PixelCrushers.DialogueSystem.plyGame.plyGameBridge:

Public Member Functions
virtual void	Awake ()
virtual void	SyncToLua ()
	Syncs plyGame data to Lua. More...
virtual void	SyncFromLua ()
	Syncs Lua data to plyGame. More...
void	SyncAttributesToLua ()
	Syncs the actor's plyGame attributes to Lua. More...
void	SyncAttributesFromLua ()
	Syncs the Lua attribute values to back to plyGame. More...
void	SyncFactionsToLua ()
	Syncs the actor's faction values to Lua. More...
void	SyncFactionsFromLua ()
	Syncs the Lua faction values back to plyGame. More...
void	SyncSkillsToLua ()
	Syncs the actor's skills to Lua. More...
void	SyncSkillsFromLua ()
	Syncs the Lua skill values back to plyGame. More...
void	SyncItemsToLua ()
	Syncs the actor's ItemBag items to Lua. More...
void	SyncItemsFromLua ()
	Syncs the Lua item data back to plyGame. More...

Public Attributes
bool	syncAttributes = true
	Set true to synchronize the actor's class attributes with the Lua Actor[] table. More...
bool	syncFactions = true
	Set true to synchronize the actor's faction values with the Lua Actor[] table. More...
bool	syncSkills = true
	Set true to synchronize the actor's skill values with the Lua Actor[] table. More...
bool	syncItems = true
	Set true to synchronize the actor's itemBag with the Lua Item[] table. More...

Protected Member Functions
string	GetPlyVarValue (plyBloxKit.plyVar plyVar)
	Gets a plyVar value as a Lua-compatible string (i.e., adding quotes if necessary). More...

Detailed Description

This script provides a bridge between plyGame data and the Dialogue System's Lua environment.

The ConversationController component uses this bridge if it's present on the actor.

Member Function Documentation

Awake()

virtual void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.Awake ( )

virtual

GetPlyVarValue()

string PixelCrushers.DialogueSystem.plyGame.plyGameBridge.GetPlyVarValue ( plyBloxKit.plyVar  plyVar )

protected

Gets a plyVar value as a Lua-compatible string (i.e., adding quotes if necessary).

Returns

The ply variable value.

Parameters

plyVar

Ply variable.

SyncAttributesFromLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncAttributesFromLua

(

)

Syncs the Lua attribute values to back to plyGame.

SyncAttributesToLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncAttributesToLua

(

)

Syncs the actor's plyGame attributes to Lua.

In Lua, they will be in the form (example): Actor["Player"].Health_Value Actor["Player"].Health_CurrentValue

SyncFactionsFromLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncFactionsFromLua

(

)

Syncs the Lua faction values back to plyGame.

SyncFactionsToLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncFactionsToLua

(

)

Syncs the actor's faction values to Lua.

In Lua they will be in the form (example): Actor["Player"].Faction_factionIdent_variableIdent

SyncFromLua()

virtual void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncFromLua ( )

virtual

Syncs Lua data to plyGame.

SyncItemsFromLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncItemsFromLua

(

)

Syncs the Lua item data back to plyGame.

SyncItemsToLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncItemsToLua

(

)

Syncs the actor's ItemBag items to Lua.

In Lua they will use: Actor["Player"].Currency Actor["Player"].CurrWeight Item["itemIdent"].Count

SyncSkillsFromLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncSkillsFromLua

(

)

Syncs the Lua skill values back to plyGame.

SyncSkillsToLua()

void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncSkillsToLua

(

)

Syncs the actor's skills to Lua.

In Lua they will be in the form (example): Actor["Player"].Skill_skillIdent

SyncToLua()

virtual void PixelCrushers.DialogueSystem.plyGame.plyGameBridge.SyncToLua ( )

virtual

Syncs plyGame data to Lua.

Member Data Documentation

syncAttributes

bool PixelCrushers.DialogueSystem.plyGame.plyGameBridge.syncAttributes = true

Set true to synchronize the actor's class attributes with the Lua Actor[] table.

syncFactions

bool PixelCrushers.DialogueSystem.plyGame.plyGameBridge.syncFactions = true

Set true to synchronize the actor's faction values with the Lua Actor[] table.

syncItems

bool PixelCrushers.DialogueSystem.plyGame.plyGameBridge.syncItems = true

Set true to synchronize the actor's itemBag with the Lua Item[] table.

syncSkills

bool PixelCrushers.DialogueSystem.plyGame.plyGameBridge.syncSkills = true

Set true to synchronize the actor's skill values with the Lua Actor[] table.

---

The documentation for this class was generated from the following file:

• D:/Documents/Unity Projects/Dialogue System/Dev/Integration/plyGame Integration/Assets/Dialogue System/Third Party Support/plyGame/Scripts/Conversation Controller/plyGameBridge.cs