All Classes Namespaces Functions Variables Enumerations Enumerator Properties
plyCommon.plyDataObject Class Reference

Retrieve and present values at run-time. Has own fields that user uses to specify where data comes from. Can also be used as a way to specify callback. More...

Public Types

enum  TargetObjectType {
  TargetObjectType.Name, TargetObjectType.Tag, TargetObjectType.Type, TargetObjectType.Active,
  TargetObjectType.None
}
 How to find the GameObject that the data will come from More...
 

Public Member Functions

plyDataObject Copy ()
 
object GetValue ()
 Called when data is wanted from a provider More...
 
void SetValue (object val)
 Called when data in a provider should be set More...
 
void Callback (string[] appendNfo)
 Called when using it as general callback. Can be passed additional string values that should be appended to the info send to the provider. More...
 

Public Attributes

string dataProviderName = ""
 Name of the data provider, as set in the editor. More...
 
TargetObjectType targetObjType = TargetObjectType.Name
 How to find the GameObject that the data will come from More...
 
string targetObjTypeData = ""
 The name, tag or component type More...
 
string componentName = ""
 Which component on the target GO to query for data. It will implement the plyDataProviderInterface interface More...
 
string[] nfo = new string[0]
 Data to pass to the interface so it knows how to retrieve the data More...
 

Properties

static GameObject activeGO [get, set]
 This is accessed at runtime when targetObjType = TargetObjectType.Active More...
 

Detailed Description

Retrieve and present values at run-time. Has own fields that user uses to specify where data comes from. Can also be used as a way to specify callback.

Member Enumeration Documentation

How to find the GameObject that the data will come from

Enumerator
Name 

by its name

Tag 

by its tag

Type 

by type of component it has. expected to be unique

Active 

it is whatever the plyDataObject.activeGO static is set to at the time

None 

meaning that there will be no GameObject to find. Normally used when the Data Object system is used in ways where the plyDataProviderInterface will not be available

Member Function Documentation

void plyCommon.plyDataObject.Callback ( string[]  appendNfo)

Called when using it as general callback. Can be passed additional string values that should be appended to the info send to the provider.

object plyCommon.plyDataObject.GetValue ( )

Called when data is wanted from a provider

void plyCommon.plyDataObject.SetValue ( object  val)

Called when data in a provider should be set

Member Data Documentation

string plyCommon.plyDataObject.componentName = ""

Which component on the target GO to query for data. It will implement the plyDataProviderInterface interface

string plyCommon.plyDataObject.dataProviderName = ""

Name of the data provider, as set in the editor.

string [] plyCommon.plyDataObject.nfo = new string[0]

Data to pass to the interface so it knows how to retrieve the data

TargetObjectType plyCommon.plyDataObject.targetObjType = TargetObjectType.Name

How to find the GameObject that the data will come from

string plyCommon.plyDataObject.targetObjTypeData = ""

The name, tag or component type

Property Documentation

GameObject plyCommon.plyDataObject.activeGO
staticgetset

This is accessed at runtime when targetObjType = TargetObjectType.Active