Class List

Here are the classes, structs, unions and interfaces with brief descriptions:

[detail level 12345]

▼NGameBase
►NAttributeExtension
CCustomAttribute	Use this PropertyAttribute to achieve indentation, readonly or conditional feature at the same time.
CHelpBoxAttribute	Use this PropertyAttribute to indicate that the string must be drawn as a HelpBox.
CReadOnlyAttribute	Use this PropertyAttribute to set the field as ReadOnly (can't be edited in the inspector)
►NRTSKit
►CRTSCamera	Controller for the camera with all the required features for a RTS, Turn based, of Moba Game.
CZoomStep	Data that holds the setup for the diferent zoom step that the camera has.
CSceneBounds	Handles the scene borders and clickeable area into the scene.
►CComponentProxy	Component class that does all the magic to store, index and return the important components from child GameObjects.
CProxyData	Contains all the data for each property
CGameEntity	Core Component for each interactable Entity in the Game. Acts as a Controller for the visual Avatar through its ComponentProxy.
CGameEntityComponent	Base class for all the Components that need to comunicate with the GameEntity and it's Visual Module.
CGameScene	Root Component that acts as central point between the GameEntities, their components and the GameSystems.
CGameSceneSystem	Base class for all the game systems.
CISelectableCriteria	When implemented, the object can filter from a list of Selectables which ones will be finally selected.
CProxyRef	Represents a Component reference that can be assigned directly through editor or must be taken from a component proxy in runtime.
CSelectable	Component in charge of store the current status for hover, highlight and selection.
CSelectableChanged	Special message triggered by the Selectable component and dispatched through the GameEntity Message Sink.
CSelectionInput	Acts as a nexus between the input (clicks, selection box, etc) and the SelectionSystem.
CSelectionSystem	The system in control of all GameEntities that can be hovered, highlighted and selected.
▼NNullPointerCore
►NAttributeExtension
CRequireGameSystemAttribute
►NBackend
►NCommands
CCommand	Base abstract class to control the command execution.
CCommandController	Class that receives custom commands to be applied to the GameEntity. This is just a first implementation of what can be a bigger feature.
►NJobScheduling
►CSimpleJob	Base class that represents a job waiting to be assigned to a slot scheduler to start working.
CISlotChanged	Supports the notifications whenever a slot its assigned or removed from a job.
►CSimpleScheduler	This class acts as a simple traffic scheduler for a certain number of jobs
CISlotSelectionCriteria	Supports the selection of the best slot for the next assignable job.
CJobSlot	basic class that represents an assignable slot for a job that needs to be started.
►NMessenger
CIMessageReceiver	Provides the methods necessary to listen messages comming from a MessageSink.
CMessage	Base class for all message used by the MessageSink.
CMessageSink	Acts as a sink for messages that will be dispatched and delivered to all the classes registered as receivers
►NResourceGathering
CCollector	Allows to fill a storage with a resource in a certain rate.
CStorage	Allows to store amounts of a resource and to specify a top limit to that stored resources;
CStorageBucket	Adds a certain amount of store capacity to a storage system.
CConditionals	Represents a list of a parameterless conditional methods
►NCoreSystem
CPlayer	Represents a player in the game (no matter if its ai, human or remote controlled) Gives a sence of ownership to the GameEntities inside the game. Just need to attach a PlayerControlled component in the GameEntity that want to be controlled and the proper player assignment.
CPlayerControlled	Indicates the player owner for a given GameEntity.
CPlayerSystem	Base class for all the player systems.
►NExtras
►CCustomEventTrigger	Receives events from the different components attached along with this component and calls registered functions for each event. The CustomEventTrigger can be used to specify functions you wish to be called for each Action event triggered for other components. You can assign multiple functions to a single event and whenever the CustomEventTrigger receives that event it will call those functions in the order they were provided. NOTE: Only parameterless Actions can be listened for the moment.
CEntry	Each entry to configure in the editor that represents an Action to listen and deliver.
CGizmosExt	Extension for the Gizmos already provided by unity
►CDLLReplaceInfo
CUnityReference	Helper clas to storage all the script references info.
CLookAtCamera
▼NNullPointerGame
►NBuildSystem
CBuildable	GameEntityComponent that allows to this GameEntity to be builded.
►CBuilder	GameEntityComponent that gives to the GameEntity the property of been able to build buildable entities.
CBuildItem	Struct info for each build item in the queue
CBuildHandler	Construction Handler that will let the user choose the next build location. Generally will be a semitransparent unit (like a ghost).
CBuildQueueChanged	Message dispatched when a item un the BuildQueue of the builder unit has changed.
CMobileBuilder	Gives the capacity to the entity to move and build units in distant places of the map
CStaticBuilder	Gives the capacity to the entity to build mobile units in a fixed position and expel it after completed
CUnitConfig	Base config for any unit that needs to built by any derived Builder Component
►NDamageSystem
CAreaOfEffect
CAttackActionConfig
►CAttackCapable
CAttackInfo
CAutoDestroy
CDamageable
CDamageType
CEffectDamage
CEffectData
CEffectHeal
CProjectile
CProjectileBeam
CProjectileMissile
►NExtras
CContentPool	Helper class to maintain a constant buffer of GameObjects ready to use, and reuse.
CMD4
CNavMeshSurfaceRefresh	Helper class to modify a nav mesh surface when an entity is instanced or destroyed.
CParticleAttractor	Special FX component that attracts particles to a point
►CPlayerOwner	Helper class to handle the existance of a Player owner for certain entity. Just is in charge of the dirty job ;)
CEvents	Events interface to handle all the player owner changes
CRTSUtilities	Common helper methods for SpaceRTS specific jobs.
►CSimpleMoveSystem	Helper class to handle simple units movement for the test scenes.
CSelectableEvent
CWaitUntilActionTriggered
►NNavigationSystem
►CNavigation	GameEntityComponent in control of the unit movement.
CData	Movement configuration for the Navigation component
CNavMeshNavigation	Specialization of the Navigation component that allows full control of the NavMeshAgent. This component will use the pathfinding provided by the navmesh system and also the avoidance capabilitys.
►NNavMeshIntegration
CNavMeshSpatialSystem	Special implementation of the SpatialSystem to use with the Unity's built-in NavMesh.
►NParkingSystem
COrbitalParking	Creates a group of Parking slot around a central point
►CParkable	Component that controls the navigation during a parking sequence agains another entity. Requires a Parking system in the destination target
CIParkingEvents	Interface to deliver the main events during the parking sequence.
CParkingJob	class that handles the parking job once a slot is assigned to it.
►CParking	The system that controls the traffic around a group of parking slots.
CSlot	The base class for the parking slots.
CWaitPoint
CQueuedWaitParking	Special case of Parking traffic controller. There is only one slot to assign but there is a ordered wait queue where to wait the slot assignment.
►NResourceSystem
►CPlayerStorageSetter	Manipulates the storage properties in the player according with a list of action entries. In each entry we can find an action to do to a specific resource type by a specific amount. Every action entry will be applied in the Start() and removed in the OnDestroy(). The most common use will be store a certain resource amount on the entity creation, resource amount that must be removed on the OnDestroy().
CEntry	Action entry configuration.
CResourceCarrier	Treats the game entity as a mobile resource storage capable of loading and unloading resources from different warehouses. A Parkable component will be required attached along with this component to handle the parking traffic control and a StorageContainer where to store the loaded or unloaded resource quantities.
CResourceCollector	Automatic resource collector. Requires a StorageContainer where to store the collected quantities.
CResourceID	Resource id type to be used by the entire resource system.
CResourcesMask	Mask to be used as filter to define a list of allowed reesources.
CResourceSystem	Manager system that defines the list of the resources that the scene will have.
CResourceWarehouse	Acts as resource port or bay transportation ready controller. Has a direct connection to a ResourceContainer that can be defined locally or in the player game object. Must be defined the valid operations that can be done in this entity (which resources are available to be extracted and which ones are available to be inserted). A parking system must be defined to control the insertion/extraction traffic.
►CStorageContainer	Container for a collection of resource storages.
CInitParams	Contains the storages initial perameters.
CStorageController	Base class for ResourceCollector and ResourceWarehouse
►NSpatial
CBuildLocationValidator	Validates the build placement selected by the user. Also handles the visual feedback.
CSpatialAreaAttribute	Attribute used to make an int variable in a script be treated as an SpatialArea.
CSpatialAreaMaskAttribute	Attribute used to make an int variable in a script be treated as an SpatialArea Mask.
CSpatialBoxModifier	SpatialModifier that defines a rectangle area in the spatial navigation.
CSpatialCircleModifier	SpatialModifier that defines a circular area in the spatial navigation.
CSpatialCylinderModifier
CSpatialModifier	Base class for all the available SpatialModifiers that can re-shape the different navigation areas.
CSpatialModifierCollector	Collects all the child SpatialModifier that matches with the current layer mask criteria. Later will be used by the current SpatialSystem implementation.
CSpatialSystem	Act as a Manager for the spatial Navigation of the map. Can be overrided to allow different Navigation methods like the Unity's built-in NavMesh system or A* Pathfinding project.
CSpatialUpdate	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.
▼NSpaceRTSKit
►NCommands
CCmdAttack
CCmdAttackMove
CCmdBuildStructure
CCmdExtractResource
CCmdMove
►NCore
CGroupController	Game system that controls the movement handler (which obtains a destination and final look direction for the moved entities.
CHumanPlayerHandler	Is the Main Controller. The RTS implementation of the GameScene. Handles the input according to the current state and send it to the game systems.
CPlaceMarker	Simply runs the "move_marker_anim" in the Animator component attached next to this one when is required.
►CPlayerUnitsInView
CIInViewListener	Interface that must be implemented by any class that wants to listen when an RTSEntity becomes in and out of the camera view frustrum.
CRTSEntity	Implements GameEntity and provides extra functionality for the RTS.
CRTSGameController
►CRTSPlayer	Keeps track of each GameEntity belonging to the player
CIInViewListener	Interface that must be implemented by any class that wants to listen when an RTSEntity becomes in and out of the camera view frustrum.
CRTSShipCarrier
CRTSShipConfig	UnitConfig implementation for ships units (capable of movement)
CRTSUnitConfig	ScriptableObject that will be used as base configuration for every unit in the game.
CRTSUnitHUD
CSimpleAI
CUnitSpawner
►CUnitSpawnerInArea
CSpawnInfo
►NFeedbackAndEffects
CConstructFeedback
CExtractionFeedback
CFXThrusters	FX component that will handle the thrusters glowing rate according to the progress value.
CFXUnderConstruction	Component that will change progressively the sharedMaterials of all of its childrens to produce the effect of being built step by step according to the progress value.
CFXValidBuildLocation
►CMaterialsCollector
CMeshDataInfo	Base class structure to hold the data for each MeshRendererand its materials that will be changed.
CSelectionFeedback	Changes the selection feedback of the GameEntity when its required by the Selectable component.
CShipMoveFeedback	Handles the movement feedback for the unit. in this case, the thrusters glowing.
►NUI
CRTSBuildableButton
CRTSCameraUI	Handles the input for the RTSCamera
CRTSExitPanel
CRTSHealthHUD
CRTSIngameHUD	Controls all the InGame HUD. Currently we have only the Construction progress bars to show but the idea is to place here all the additional HUD overlays, like the units life when the cursor is over a unit, etc.
CRTSMessageDisplay
CRTSMissionTimerHUD
CRTSPointerInput
CRTSResourceUI
CRTSSelectionBoxUI	Handles the input for the selection system related to the selection box feature.
CRTSUnitBuildUI	UI Panel controller for the build capability of ships and structures.
CUIProgressBar	Simple class to manage a tileable Progress bar for the ui.
CUIUnitInfo