Space Engineers
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Sandbox.Game.Entities.MyDataReceiver Class Referenceabstract
Inheritance diagram for Sandbox.Game.Entities.MyDataReceiver:
VRage.Game.Components.MyEntityComponentBase VRage.Game.Components.MyComponentBase Sandbox.Game.Entities.Blocks.MyLaserReceiver Sandbox.Game.Entities.Cube.MyRadioReceiver

Public Member Functions

void UpdateBroadcastersInRange ()
 
HashSet< MyDataBroadcasterGetRelayedBroadcastersForPlayer (long localPlayerId)
 
void UpdateBroadcastersInRange (HashSet< MyDataBroadcaster > relayedBroadcasters, long localPlayerId, HashSet< long > gridsQueued)
 
bool CanIUseIt (MyDataBroadcaster broadcaster, long localPlayerId)
 
void UpdateHud (bool showMyself=false)
 
void Clear ()
 
- Public Member Functions inherited from VRage.Game.Components.MyEntityComponentBase
override void OnAddedToContainer ()
 Gets called after the container of this component changes More...
 
override void OnBeforeRemovedFromContainer ()
 Gets called before the removal of this component from a container More...
 
- Public Member Functions inherited from VRage.Game.Components.MyComponentBase
virtual void SetContainer (MyComponentContainer container)
 Sets the container of this component. Note that the component is not added to the container here! Therefore, use MyComponentContainer.Add(...) method and it will in turn call this method. Actually, you should seldom have the need to call this method yourself. More...
 
virtual T GetAs< T > ()
 
virtual void OnAddedToScene ()
 CH: TOOD: Be careful! This does not get called if the component is added to a container that is in the scene already! More...
 
virtual void OnRemovedFromScene ()
 CH: TOOD: Be careful! This does not get called if the component is removed from a container that is still in the scene! More...
 
virtual MyObjectBuilder_ComponentBase Serialize (bool copy=false)
 
virtual void Deserialize (MyObjectBuilder_ComponentBase builder)
 
virtual void Init (MyComponentDefinitionBase definition)
 
virtual bool IsSerialized ()
 Tells the component container serializer whether this component should be saved More...
 

Static Public Member Functions

static HashSet< MyDataReceiverGetGridRadioReceivers (MyCubeGrid grid)
 
static HashSet< MyDataReceiverGetGridRadioReceivers (MyCubeGrid grid, long playerId)
 

Protected Member Functions

abstract void GetAllBroadcastersInMyRange (ref HashSet< MyDataBroadcaster > relayedBroadcasters, long localPlayerId, HashSet< long > gridsQueued)
 

Protected Attributes

List< MyDataBroadcasterm_broadcastersInRange = new List<MyDataBroadcaster>()
 
HashSet< MyDataBroadcasterm_relayedBroadcasters = new HashSet<MyDataBroadcaster>()
 
HashSet< MyDataBroadcasterm_relayedBroadcastersForPlayer = new HashSet<MyDataBroadcaster>()
 
HashSet< long > m_relayerGrids = new HashSet<long>()
 

Properties

bool Enabled [get, set]
 
HashSet< MyDataBroadcasterRelayedBroadcasters [get]
 
override string ComponentTypeDebugString [get]
 
- Properties inherited from VRage.Game.Components.MyEntityComponentBase
MyEntityComponentContainer Container [get]
 
IMyEntity Entity [get]
 
abstract string ComponentTypeDebugString [get]
 Name of the base component type for debug purposes (e.g.: "Position") More...
 
- Properties inherited from VRage.Game.Components.MyComponentBase
MyComponentContainer ContainerBase [get]
 This cannot be named Container to not conflict with the definition of Container in MyEntityComponentBase. More...
 

Additional Inherited Members

- Events inherited from VRage.Game.Components.MyEntityComponentBase
static Action< MyEntityComponentBaseOnAfterAddedToContainer
 
Action< MyEntityComponentBaseBeforeRemovedFromContainer
 

Detailed Description

Definition at line 18 of file MyDataReceiver.cs.

Member Function Documentation

bool Sandbox.Game.Entities.MyDataReceiver.CanIUseIt ( MyDataBroadcaster  broadcaster,
long  localPlayerId 
)
inline

Definition at line 153 of file MyDataReceiver.cs.

void Sandbox.Game.Entities.MyDataReceiver.Clear ( )
inline

Definition at line 251 of file MyDataReceiver.cs.

abstract void Sandbox.Game.Entities.MyDataReceiver.GetAllBroadcastersInMyRange ( ref HashSet< MyDataBroadcaster relayedBroadcasters,
long  localPlayerId,
HashSet< long >  gridsQueued 
)
protectedpure virtual
static HashSet<MyDataReceiver> Sandbox.Game.Entities.MyDataReceiver.GetGridRadioReceivers ( MyCubeGrid  grid)
inlinestatic

Definition at line 36 of file MyDataReceiver.cs.

static HashSet<MyDataReceiver> Sandbox.Game.Entities.MyDataReceiver.GetGridRadioReceivers ( MyCubeGrid  grid,
long  playerId 
)
inlinestatic

Definition at line 42 of file MyDataReceiver.cs.

HashSet<MyDataBroadcaster> Sandbox.Game.Entities.MyDataReceiver.GetRelayedBroadcastersForPlayer ( long  localPlayerId)
inline

Definition at line 88 of file MyDataReceiver.cs.

void Sandbox.Game.Entities.MyDataReceiver.UpdateBroadcastersInRange ( )
inline

Definition at line 81 of file MyDataReceiver.cs.

void Sandbox.Game.Entities.MyDataReceiver.UpdateBroadcastersInRange ( HashSet< MyDataBroadcaster relayedBroadcasters,
long  localPlayerId,
HashSet< long >  gridsQueued 
)
inline

Definition at line 96 of file MyDataReceiver.cs.

void Sandbox.Game.Entities.MyDataReceiver.UpdateHud ( bool  showMyself = false)
inline

Definition at line 175 of file MyDataReceiver.cs.

Member Data Documentation

List<MyDataBroadcaster> Sandbox.Game.Entities.MyDataReceiver.m_broadcastersInRange = new List<MyDataBroadcaster>()
protected

Definition at line 20 of file MyDataReceiver.cs.

HashSet<MyDataBroadcaster> Sandbox.Game.Entities.MyDataReceiver.m_relayedBroadcasters = new HashSet<MyDataBroadcaster>()
protected

Definition at line 21 of file MyDataReceiver.cs.

HashSet<MyDataBroadcaster> Sandbox.Game.Entities.MyDataReceiver.m_relayedBroadcastersForPlayer = new HashSet<MyDataBroadcaster>()
protected

Definition at line 23 of file MyDataReceiver.cs.

HashSet<long> Sandbox.Game.Entities.MyDataReceiver.m_relayerGrids = new HashSet<long>()
protected

Definition at line 80 of file MyDataReceiver.cs.

Property Documentation

override string Sandbox.Game.Entities.MyDataReceiver.ComponentTypeDebugString
get

Definition at line 263 of file MyDataReceiver.cs.

bool Sandbox.Game.Entities.MyDataReceiver.Enabled
getset

Definition at line 24 of file MyDataReceiver.cs.

HashSet<MyDataBroadcaster> Sandbox.Game.Entities.MyDataReceiver.RelayedBroadcasters
get

Definition at line 29 of file MyDataReceiver.cs.


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