Drag[en]gine Script Module DragonScript Script API  1.0
SynchronizedFloat Class Reference

Synchronized floating point value. More...

Inheritance diagram for SynchronizedFloat:

Public Member Functions

Constructors
SynchronizedFloat new ()
 Create synchronized floating point value with initial value of 0. More...
 
SynchronizedFloat new (float value)
 Create synchronized floating point value with initial value. More...
 
SynchronizedFloat new (SynchronizedFloat copy)
 Create copy of synchronized floating point value. More...
 
Management
float getValue ()
 Value of network state or local value if not set. More...
 
void setValue (float value)
 Set value and update network state if set. More...
 
NetworkState getNetworkState ()
 Linked network state or null if not set. More...
 
int getNetworkStateValue ()
 Linked network state value index or -1 if not set. More...
 
void setNetworkState (NetworkState state, int value)
 Set network state value to synchronize or null to clear. More...
 

Detailed Description

Synchronized floating point value.

Local floating point value optionally synchronized across the network using a NetworkState value.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ getNetworkState()

NetworkState getNetworkState ( )

Linked network state or null if not set.

§ getNetworkStateValue()

int getNetworkStateValue ( )

Linked network state value index or -1 if not set.

§ getValue()

float getValue ( )

Value of network state or local value if not set.

§ new() [1/3]

Create synchronized floating point value with initial value of 0.

§ new() [2/3]

SynchronizedFloat new ( float  value)

Create synchronized floating point value with initial value.

§ new() [3/3]

Create copy of synchronized floating point value.

§ setNetworkState()

void setNetworkState ( NetworkState  state,
int  value 
)

Set network state value to synchronize or null to clear.

Exceptions
EOutOfBoundaryvalue is less than 0 or larger than or equal to network state value count.

§ setValue()

void setValue ( float  value)

Set value and update network state if set.


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