SpaceRTS - Starter Pack  1.3
NullPointerGame.Spatial.SpatialUpdate Class Reference

Collects all the SpatialModifiers that it can found in the VisualProxy and registers it at the SpatialSystem to re-shape the Navigation areas of the map. More...

Inheritance diagram for NullPointerGame.Spatial.SpatialUpdate:
GameBase.GameEntityComponent

Public Member Functions

void OnEnable ()
 Collects and registers all the SpatialModifiers that can find in the VisualProxy. More...
 
void OnDisable ()
 Unregisters all the cached SpatialModifiers from the SpatialSystem More...
 
override void OnVisualModuleSetted ()
 Collects all the modifiers in the VisualProxy and registers it at the SpatialSystem More...
 
override void OnVisualModuleRemoved ()
 Unregister all the cached modifiers from the spatial system More...
 
void CollectModifiers ()
 Collects all the SpatialModifiers that can found in the VisualProxy. More...
 

Properties

IEnumerable< SpatialModifierModifiers [get]
 An enumeration of all the already collected modifiers that it can found in the VisualProxy. More...
 
SpatialSystem Spatial [get]
 Cache for the SpatialSystem More...
 
- Properties inherited from GameBase.GameEntityComponent
GameEntity ThisEntity [get]
 The GameEntity attached to this component. More...
 
MessageSink Messages [get]
 Shortcut for the Message sink located at the GameEntity attached to this component. More...
 
ComponentProxy VisualProxy [get]
 Shortcut for the ComponentProxy located at the GameEntity attached to this component. More...
 

Additional Inherited Members

- Protected Member Functions inherited from GameBase.GameEntityComponent
virtual void SetupEntityComponent ()
 virtual class to be implemented. This will be called on the Awake to do a proper initialization of the component ensuring that the GameEntity thisEntity it's already defined at this point. Version 1.1: This will no longer be used in the future. Use instead OnVisualModuleSetted and OnVisualModuleRemoved. More...
 
virtual void OnValidate ()
 Called by unity when the script is reloaded. Here we setup the component and check that all is setted correctly. More...
 
GetSceneSystem< T > ()
 Shortcut for access a SceneSystem registered in the GameScene. More...
 
GetVisualProxyProperty< T > (string name)
 Shortcut for access the property located at the GameEntity visual module. More...
 
void LogsClear ()
 Clears all log messages More...
 
void Log (string message)
 Stores the message as a log that can be used later to show a warning in the editor or console. More...
 
void PushLogs ()
 Push all the stored logs to the console. More...
 

Detailed Description

Collects all the SpatialModifiers that it can found in the VisualProxy and registers it at the SpatialSystem to re-shape the Navigation areas of the map.

Member Function Documentation

◆ CollectModifiers()

void NullPointerGame.Spatial.SpatialUpdate.CollectModifiers ( )

Collects all the SpatialModifiers that can found in the VisualProxy.

◆ OnDisable()

void NullPointerGame.Spatial.SpatialUpdate.OnDisable ( )

Unregisters all the cached SpatialModifiers from the SpatialSystem

◆ OnEnable()

void NullPointerGame.Spatial.SpatialUpdate.OnEnable ( )

Collects and registers all the SpatialModifiers that can find in the VisualProxy.

◆ OnVisualModuleRemoved()

override void NullPointerGame.Spatial.SpatialUpdate.OnVisualModuleRemoved ( )
virtual

Unregister all the cached modifiers from the spatial system

Reimplemented from GameBase.GameEntityComponent.

◆ OnVisualModuleSetted()

override void NullPointerGame.Spatial.SpatialUpdate.OnVisualModuleSetted ( )
virtual

Collects all the modifiers in the VisualProxy and registers it at the SpatialSystem

Reimplemented from GameBase.GameEntityComponent.

Property Documentation

◆ Modifiers

IEnumerable<SpatialModifier> NullPointerGame.Spatial.SpatialUpdate.Modifiers
get

An enumeration of all the already collected modifiers that it can found in the VisualProxy.

◆ Spatial

SpatialSystem NullPointerGame.Spatial.SpatialUpdate.Spatial
get

Cache for the SpatialSystem