Public Member Functions | Public Attributes | List of all members
PixelCrushers.DialogueSystem.UFPS.FPSyncLuaPlayerOnConversation Class Reference

This script synchronizes the Dialogue System's Lua environment with the UFPS player whenever a conversation starts or ends. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UFPS.FPSyncLuaPlayerOnConversation:
Inheritance graph
[legend]
Collaboration diagram for PixelCrushers.DialogueSystem.UFPS.FPSyncLuaPlayerOnConversation:
Collaboration graph
[legend]

Public Member Functions

void OnConversationStart (Transform actor)
 
void OnConversationEnd (Transform actor)
 

Public Attributes

bool disableWeaponDuringConversations = true
 Set true to disable the player's weapon during conversations. More...
 

Detailed Description

This script synchronizes the Dialogue System's Lua environment with the UFPS player whenever a conversation starts or ends.

To use it, add it to the player object.

It currently synchronizes: health and inventory.

Every weapon (e.g., "Pistol") has an associated Lua variable (e.g., Variable["Pistol"]) that is equal to the count or ammo count (if it uses ammo) if the player has the weapon or 0 if the player doesn't. During conversations, your dialogue entries can check and/or set the values using Lua conditions and scripts.

Member Function Documentation

◆ OnConversationEnd()

void PixelCrushers.DialogueSystem.UFPS.FPSyncLuaPlayerOnConversation.OnConversationEnd ( Transform  actor)

◆ OnConversationStart()

void PixelCrushers.DialogueSystem.UFPS.FPSyncLuaPlayerOnConversation.OnConversationStart ( Transform  actor)

Member Data Documentation

◆ disableWeaponDuringConversations

bool PixelCrushers.DialogueSystem.UFPS.FPSyncLuaPlayerOnConversation.disableWeaponDuringConversations = true

Set true to disable the player's weapon during conversations.

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