### Mod Configuration File Example (Info.yaml)

Source: https://github.com/moicky/empy-docs/blob/main/html/index.html

An example of a mod configuration file, which must have the same name as the mod's DLL file with '_Info.yaml' appended. This file provides information about the mod and specifies which game processes it should load with.

```yaml
DemoMod_Info.yaml
```

--------------------------------

### Empy API: PDA Wave Start Data Class

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_c.html

Documentation for the WaveStartData class in the Eleon.Pda namespace, likely used to define parameters for starting a wave of enemies or events in the game. It may contain information about wave composition or timing.

```C#
Eleon.Pda.WaveStartData
```

--------------------------------

### Get Start Playfield

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player.html

Represents the name of the playfield where the player started. This is a string value.

```C#
string StartPlayfield { get; }
```

--------------------------------

### Get Player Start Playfield

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_player_info_set.html

Retrieves the starting playfield for a player. This property is of type string.

```C#
string Eleon.Modding.PlayerInfoSet.startPlayfield
```

--------------------------------

### Setting up a Class Library Project for Empyrion Mods

Source: https://github.com/moicky/empy-docs/blob/main/html/index.html

Instructions for setting up a new modding project in an IDE. It requires creating a 'Class Library' project and adding specific DLL references from the game's installation directory.

```text
1. Create a project of type 'Class Library' (in the end we need to have a dll)
2. Add references to Mif.dll and ModApi.dll that can be found in the game's install folder under `Empyrion[...]_Data/Managed`
```

--------------------------------

### Get Player Start Playfield

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player.html

Retrieves the name of the playfield where the player started. This is a read-only property of the IPlayer interface.

```C#
string StartPlayfield { get; }
```

--------------------------------

### Document Ready and Resizable Initialization

Source: https://github.com/moicky/empy-docs/blob/main/html/dir_743cbcd4eb629908f5330bacc1a83a6a.html

Ensures that the navigation tree and resizable elements are initialized once the document is fully loaded. This is a common pattern in Doxygen-generated documentation for interactive features.

```JavaScript
$(document).ready(function(){initNavTree('dir_743cbcd4eb629908f5330bacc1a83a6a.html',''); initResizable(); });
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/struct_eleon_1_1_modding_1_1_faction_info-members.html

Initializes the menu for the documentation page, likely setting up search functionality and initial display states. This is a standard Doxygen initialization script.

```javascript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Get Structure Light Count

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Returns the number of lights installed within the structure. This property is read-only.

```C#
int Eleon.Modding.IStructure.LightCount { get; }
```

--------------------------------

### Document Ready and Resizable Initialization

Source: https://github.com/moicky/empy-docs/blob/main/html/_readme_main_8md.html

Ensures that the navigation tree and resizable elements are initialized once the document is fully loaded. This is a common pattern in Doxygen-generated HTML documentation.

```JavaScript
$(document).ready(function(){initNavTree('_readme_main_8md.html',''); initResizable(); });
```

--------------------------------

### Get Structure Device Count

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Returns the number of devices installed within the structure. This property is read-only.

```C#
int Eleon.Modding.IStructure.DeviceCount { get; }
```

--------------------------------

### Get Signal Name

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Retrieves the name of the send signal associated with a block at a given position. Returns null if the block does not have a send signal setup.

```C#
string Eleon.Modding.IStructure.GetSendSignalName(VectorInt3 pos)
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/_shared_utils_8cs.html

Initializes the menu functionality for the documentation page, likely setting up search and navigation elements. This is a standard Doxygen JavaScript initialization.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Document Ready Initialization - JavaScript

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_portal-members.html

Ensures that the navigation tree and resizable elements are initialized once the HTML document is fully loaded and ready. This uses jQuery.

```JavaScript
$(document).ready(function(){initNavTree('interface_eleon_1_1_modding_1_1_i_portal.html',''); initResizable(); });
```

--------------------------------

### TaskData OnActivateSignal Property

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_task_data.html

Gets or sets a SignalDescriptor for the event that occurs when the task is activated. This allows for custom logic or events to be triggered upon task start.

```C#
public SignalDescriptor OnActivateSignal { get; set; }

```

--------------------------------

### Start Timer

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_pda.html

Manually starts a timer identified by its unique ID.

```C#
void Eleon.Modding.IPda.StartTimer(
	string _id_
)
```

--------------------------------

### Eleon Modding: IMod Init Method Reference

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_i.html

References the 'Init()' method in the Eleon.Modding.IMod interface, which is likely called to initialize a mod.

```C#
Eleon.Modding.IMod()
```

--------------------------------

### Initialize Navigation Tree and Resize - JavaScript

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_pda_1_1_i_parent_link-members.html

Initializes the navigation tree for the Eleon.Pda.IParentLink interface and enables resizable panels. This is typically part of the Doxygen-generated documentation framework.

```JavaScript
$(document).ready(function(){initNavTree('interface_eleon_1_1_pda_1_1_i_parent_link.html',''); initResizable(); });
```

--------------------------------

### Guiding - Eleon.Pda.ActionData / Eleon.Pda.ChapterActivationData

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Represents guiding information, possibly for actions or chapter activation. This property appears in both Eleon.Pda.ActionData and Eleon.Pda.ChapterActivationData.

```C#
Eleon.Pda.ActionData.Guiding
```

```C#
Eleon.Pda.ChapterActivationData.Guiding
```

--------------------------------

### Guiding Property

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_chapter_activation_data.html

Details the Guiding property of the ChapterActivationData class, which uses the GuidingType enumeration.

```C#
[GuidingType](namespace_eleon_1_1_pda.html#a5de29de85e96793ecdf25018df001597) Eleon.Pda.ChapterActivationData.Guiding
getset
```

--------------------------------

### Initialize Navigation Tree

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_wave_start_data-members.html

Initializes the navigation tree for the documentation, likely using a JavaScript library like jQuery. It sets up the initial state and makes the tree resizable.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_pda_1_1_wave_start_data.html',''); initResizable(); });
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_p_string-members.html

Initializes the menu for the documentation site and sets up the search functionality. This script is typically found in Doxygen-generated HTML.

```javascript
initMenu('',false,false,'search.php','Search');
```

--------------------------------

### Get Container Volume Capacity

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_container.html

Gets or sets the volume capacity of the container in liters.

```C#
float Eleon.Modding.IContainer.VolumeCapacity { get; set; }
```

--------------------------------

### Initialize Menu - JavaScript

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_pda_1_1_i_parent_link-members.html

Initializes the menu for the Empyrion Modding documentation, likely setting up search functionality and initial display states. This uses jQuery.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Start Timer

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_pda.html

Manually starts a previously created timer using its unique string ID.

```C#
void StartTimer(string id)
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/struct_eleon_1_1_modding_1_1_global_structure_info-members.html

Initializes the navigation tree for the Eleon.Modding.GlobalStructureInfo class and enables resizable elements. This is a common pattern for setting up documentation pages with interactive navigation.

```JavaScript
$(document).ready(function(){initNavTree('struct_eleon_1_1_modding_1_1_global_structure_info.html',''); initResizable(); });
```

--------------------------------

### Eleon.Modding.IPlayer - Get Radiation

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player-members.html

Gets the current radiation level of the player. This property is relevant for games with radiation mechanics or environmental hazards.

```C#
float Radiation;
```

--------------------------------

### PDA Task Data Management

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_s.html

Properties for managing task data within the PDA, including start delays and start messages.

```C#
StartDelay
StartMessage
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/struct_eleon_1_1_modding_1_1_pda_state_info-members.html

Initializes the navigation tree for the documentation and enables resizable elements. This is typically part of the page setup for Doxygen-generated documentation.

```javascript
$(document).ready(function(){initNavTree('struct_eleon_1_1_modding_1_1_pda_state_info.html',''); initResizable(); });
```

--------------------------------

### Eleon.Modding.IPlayer - Get Oxygen

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player-members.html

Gets the current oxygen level of the player. This property is crucial for survival mechanics in games where oxygen management is a factor.

```C#
float Oxygen;
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_mod_game_a_p_i-members.html

Initializes the navigation tree for the documentation and makes it resizable. This is a common pattern in Doxygen-generated documentation to enhance user experience.

```JavaScript
$(document).ready(function(){initNavTree('interface_eleon_1_1_modding_1_1_mod_game_a_p_i.html',''); initResizable(); });
```

--------------------------------

### Get and Set Light Range

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_light.html

Enables getting and setting the effective range of a light source. The range is defined by a float value.

```C#
float GetRange ()

```

```C#
void SetRange (float range)

```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/struct_eleon_1_1_modding_1_1_pda_state_info-members.html

Initializes the menu for the documentation, disabling search and setting up the search functionality. This is a common pattern in Doxygen-generated documentation.

```javascript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Create Timer

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_pda.html

Creates a timer that will execute a specified action after a given duration. The timer can be set to start immediately or be manually started later.

```C#
void CreateTimer(string id, float duration, Action timerAction, bool bImmediate = false)
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_chapter_category_comparer-members.html

Initializes the navigation tree for the documentation and enables resizable elements. This is typically used in conjunction with Doxygen-generated documentation.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_pda_1_1_chapter_category_comparer.html',''); initResizable(); });
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_prop_w.html

Initializes the menu for the documentation site, likely setting up search functionality. This is a standard JavaScript initialization for Doxygen sites.

```JavaScript
initMenu('',false,false,'search.php','Search');
```

--------------------------------

### WaveStartData Class for PDA Wave Starts

Source: https://github.com/moicky/empy-docs/blob/main/html/annotated.html

Data related to the start of a wave or encounter within the PDA system, possibly for combat or event sequences.

```C++
class WaveStartData
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_wave_start_data-members.html

Initializes the menu for the documentation, likely disabling search and setting up default menu behavior. This is often part of a documentation generation tool like Doxygen.

```JavaScript
initMenu('',false,false,'search.php','Search');
```

--------------------------------

### Get Path for Application Folder in Empyrion Modding

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_application-members.html

Gets the file path for a specified application folder. Requires an AppFolder enum value.

```C#
GetPathFor(AppFolder appFolder)
```

--------------------------------

### Eleon.Modding.IPlayer - Get Stamina

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player-members.html

Gets the current stamina level of the player. Stamina is often used for actions like running or special abilities, impacting player performance.

```C#
float Stamina;
```

--------------------------------

### Initialize Menu and Search

Source: https://github.com/moicky/empy-docs/blob/main/html/_readme_main_8md.html

Initializes the menu and search functionality for the documentation. This JavaScript code snippet is typically part of a Doxygen-generated documentation site.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_chapter_data-members.html

Initializes the menu for the Empyrion Modding documentation, likely setting up search functionality. This snippet is a common pattern in JavaScript for initializing UI elements.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Eleon.Modding.IEntity - Get Position

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player-members.html

Gets the current position of the entity in 3D space. The Position property is vital for spatial awareness and manipulation of entities within the game world.

```C#
Vector3 Position;
```

--------------------------------

### Initialize Document Ready and Resizable

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_alliances_faction-members.html

Ensures that the navigation tree is initialized and the layout is resizable once the document is fully loaded. This is standard practice for interactive web documentation.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_modding_1_1_alliances_faction.html',''); initResizable(); });
```

--------------------------------

### Eleon.Modding.IPlayer - Start Playfield

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player-members.html

Initiates or starts the player's presence or activity within a specific playfield. This method is likely used to load or activate player-related game logic.

```C#
void StartPlayfield();
```

--------------------------------

### Get and Set Blink Data

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_light.html

Provides functionality to get and set the blinking parameters for a light source, including interval, length, and offset. These are all float values.

```C#
void GetBlinkData (out float blinkInterval, out float blinkLength, out float blinkOffset)

```

```C#
void SetBlinkData (float blinkInterval, float blinkLength, float blinkOffset)

```

--------------------------------

### Initialize Menu and Search

Source: https://github.com/moicky/empy-docs/blob/main/html/dir_743cbcd4eb629908f5330bacc1a83a6a.html

Initializes the menu and search functionality for the documentation site. This JavaScript code is typically found in the header or footer of a Doxygen-generated site.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Start Coroutine in Empyrion Modding

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_script.html

Starts a coroutine, which is a function that can pause its execution and return control to the caller, resuming later. This is useful for asynchronous operations or timed events.

```C#
Coroutine Eleon.Modding.IScript.StartCoroutine(IEnumerator e)
```

--------------------------------

### Initialize JavaScript Navigation Tree and Resizable Layout

Source: https://github.com/moicky/empy-docs/blob/main/html/dir_5edfa08126cee1a759942700a0d06ef2.html

Initializes the navigation tree and makes the layout resizable. This is standard for Doxygen documentation to provide an interactive browsing experience.

```JavaScript
$(document).ready(function(){initNavTree('dir_5edfa08126cee1a759942700a0d06ef2.html',''); initResizable(); });
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_p_string-members.html

Initializes the navigation tree for the documentation and enables resizable elements. This is a common pattern in Doxygen-generated documentation sites.

```javascript
$(document).ready(function(){
  initNavTree('class_eleon_1_1_modding_1_1_p_string.html','');
  initResizable();
});
```

--------------------------------

### Eleon.Modding.IPlayer - Get Upgrade Points

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_player-members.html

Gets the number of upgrade points the player currently possesses. Upgrade points are typically used to enhance player abilities or unlock new features.

```C#
int UpgradePoints;
```

--------------------------------

### Initialize Navigation Tree and Resizable

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_inventory-members.html

Initializes the navigation tree for the documentation and enables resizable panels. This is typically part of the Doxygen-generated documentation framework.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_modding_1_1_inventory.html',''); initResizable(); });
```

--------------------------------

### Get Container Decay Factor

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_container.html

Gets or sets the decay factor for items in the container. A value of 1 means standard decay, while 0 means no decay. Currently, only 0 or 1 are supported.

```C#
float Eleon.Modding.IContainer.DecayFactor { get; set; }
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/_faction_data_8cs.html

Initializes the main menu and search functionality for the documentation. This JavaScript code sets up the interactive elements for navigating and searching through the project's documentation.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_trader_n_p_c_item_sold_info-members.html

Initializes the menu for the documentation interface, likely including search functionality. This is a standard JavaScript initialization for Doxygen sites.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_msg_channel_comparer-members.html

Initializes the menu for the documentation, disabling search and setting up the search functionality. This is a common pattern in Doxygen-generated documentation.

```JavaScript
initMenu('',false,false,'search.php','Search');
```

--------------------------------

### Get and Set Lock Code of Eleon Block

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_block.html

Gets or sets the lock code for a block. A null value indicates no lock code. Setting the code propagates via the network. A code of zero allows any player access.

```C#
int? Eleon.Modding.IBlock.LockCode { get; set; }
{
    // Implementation details not provided in the source text.
    // Example: Eleon.Modding.IBlock.LockCode = 1234;
    // Example: int? code = Eleon.Modding.IBlock.LockCode;
}
```

--------------------------------

### Empyrion Modding: Initialize Mod

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_func_i.html

Initializes the mod, likely performing setup tasks or registering components. This is a standard entry point for mod functionality.

```C#
Init() : Eleon.Modding.IMod
```

--------------------------------

### GetSwitchState - Eleon.Modding.IBlock

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the state of a switch on a block. This function is part of the IBlock interface.

```C#
Eleon.Modding.IBlock.GetSwitchState()
```

--------------------------------

### GetPathFor - Eleon.Modding.IApplication

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the path for a specified application. This function belongs to the IApplication interface.

```C#
Eleon.Modding.IApplication.GetPathFor()
```

--------------------------------

### Initialize JavaScript Menu and Search

Source: https://github.com/moicky/empy-docs/blob/main/html/dir_5edfa08126cee1a759942700a0d06ef2.html

Initializes the JavaScript menu and search functionality for the documentation site. This is a common pattern for Doxygen-generated documentation.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Initialize Navigation Tree and Resizable

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_faction_change_info-members.html

Initializes the navigation tree for the documentation and enables resizable panels. This is typically part of the Doxygen-generated documentation setup.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_modding_1_1_faction_change_info.html',''); initResizable(); });
```

--------------------------------

### Get Block Damage

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_block-members.html

Retrieves the current damage value of a block.

```C#
public void GetDamage();
```

--------------------------------

### Initialize Navigation Tree and Resizable Layout

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_global_structure_list-members.html

Initializes the navigation tree for the documentation and enables resizable panels. This is a common pattern in Doxygen-generated documentation to enhance user experience.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_modding_1_1_global_structure_list.html',''); initResizable(); });
```

--------------------------------

### GetTotalItems - Eleon.Modding.IContainer

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the total number of items in a container. This function is part of the IContainer interface.

```C#
Eleon.Modding.IContainer.GetTotalItems()
```

--------------------------------

### GetSignalState - Eleon.Modding.IStructure

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the current state of a signal for a structure. This function is part of the IStructure interface.

```C#
Eleon.Modding.IStructure.GetSignalState()
```

--------------------------------

### Initialize Mod with IModApi

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_mod.html

The Init method is called when a mod is loaded, providing an instance of the IModApi interface. This serves as a constructor for the mod, allowing it to access game functionalities.

```C#
void Eleon.Modding.IMod.Init(IModApi modAPI)
```

--------------------------------

### GetSendSignalName - Eleon.Modding.IStructure

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the name of the signal being sent by a structure. This function is part of the IStructure interface.

```C#
Eleon.Modding.IStructure.GetSendSignalName()
```

--------------------------------

### Initialize Navigation Tree and Resizable

Source: https://github.com/moicky/empy-docs/blob/main/html/_shared_utils_8cs.html

Initializes the navigation tree and makes it resizable. This is a common pattern in Doxygen-generated documentation for managing the sidebar.

```JavaScript
$(document).ready(function(){initNavTree('_shared_utils_8cs.html',''); initResizable(); });
```

--------------------------------

### GetPoiLocation - Eleon.Modding.IPda

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the location of a Point of Interest (POI). This function is part of the IPda interface.

```C#
Eleon.Modding.IPda.GetPoiLocation()
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/struct_eleon_1_1_modding_1_1_game_event_data-members.html

Initializes the menu for the documentation page, likely setting up search functionality and initial display states. This is part of the Doxygen JavaScript framework.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_trader_n_p_c_item_sold_info-members.html

Initializes the navigation tree for the documentation and enables resizable elements. This is a common pattern in Doxygen-generated documentation to enhance user experience.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_modding_1_1_trader_n_p_c_item_sold_info.html',''); initResizable(); });
```

--------------------------------

### Get TotalMass Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Retrieves the total mass of the structure.

```C#
public float TotalMass { get; }
```

--------------------------------

### Get SizeClass Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Retrieves the size class of the structure.

```C#
public int SizeClass { get; }
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_id_item_stack-members.html

Initializes the menu system and search functionality for the documentation. This JavaScript code sets up the user interface elements for navigation and searching through the API documentation.

```JavaScript
initMenu('',false,false,'search.php','Search');
```

--------------------------------

### Get Playfield Type Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_playfield.html

Retrieves the type of the playfield.

```C#
string PlayfieldType { get; }
```

--------------------------------

### Empyrion Modding: WaveStartData Function

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_func_w.html

Provides information about the WaveStartData function, including its return type and a link to its documentation within the Eleon.Pda namespace.

```C++
WaveStartData() : [Eleon.Pda.WaveStartData](class_eleon_1_1_pda_1_1_wave_start_data.html#ab06b22ed7a2f186e4d4915dbfa1d8293)
```

--------------------------------

### Initialize Menu

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_prop_n.html

Initializes the menu for the documentation site, likely setting up search functionality and initial display states. This is a standard JavaScript initialization for Doxygen sites.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Get Playfield Name Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_playfield.html

Retrieves the name of the playfield.

```C#
string Name { get; }
```

--------------------------------

### GetPlayfieldByPlanetType - Eleon.Modding.IPda

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_g.html

Gets the playfield associated with a specific planet type. This function is part of the IPda interface.

```C#
Eleon.Modding.IPda.GetPlayfieldByPlanetType()
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_id_msg_prio-members.html

Initializes the menu system and search functionality for the documentation. This JavaScript code sets up the interactive elements of the documentation site.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Document Ready Initialization

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_device_pos_list-members.html

Ensures that the navigation tree and resizable elements are initialized once the HTML document is fully loaded and parsed. This is a common pattern in web development using jQuery.

```javascript
$(document).ready(function(){initNavTree('interface_eleon_1_1_modding_1_1_i_device_pos_list.html',''); initResizable(); });
```

--------------------------------

### Shutdown Mod

Source: https://github.com/moicky/empy-docs/blob/main/html/functions_func_s.html

Shuts down the mod. This function is part of the IMod interface.

```C#
Shutdown() : [Eleon.Modding.IMod](interface_eleon_1_1_modding_1_1_i_mod.html#a74415c4b6d52fc0e5b22439441950ee0)
```

--------------------------------

### Get ShieldLevel Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Retrieves the current shield level of the structure.

```C#
public int ShieldLevel { get; }
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_id_structure_block_info-members.html

Initializes the menu system and search functionality for the documentation. This JavaScript code sets up the interactive elements for navigating and searching through the project's documentation.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Initialize Navigation Tree and Resizable Elements

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_pda_1_1_reward_data-members.html

Initializes the navigation tree for the documentation and enables resizable elements. This is a common pattern in Doxygen-generated documentation to enhance user experience.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_pda_1_1_reward_data.html',''); initResizable(); });
```

--------------------------------

### Get PowerOutCapacity Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Retrieves the power output capacity of the structure.

```C#
public int PowerOutCapacity { get; }
```

--------------------------------

### Get PowerConsumption Property

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_structure.html

Retrieves the current power consumption of the structure.

```C#
public int PowerConsumption { get; }
```

--------------------------------

### Initialize Document Ready

Source: https://github.com/moicky/empy-docs/blob/main/html/struct_eleon_1_1_modding_1_1_item_stack2-members.html

Initializes the document when it's ready, setting up navigation and search functionality. This is a common pattern for web page initialization.

```JavaScript
$(document).ready(initResizable);
```

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

```JavaScript
$(document).ready(function(){initNavTree('struct_eleon_1_1_modding_1_1_item_stack2.html','');});
```

--------------------------------

### Initialize Navigation Tree and Resizable Layout

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_id_structure_block_info-members.html

Initializes the navigation tree for the documentation and enables resizable panels. This is a common pattern in Doxygen-generated documentation to enhance user experience.

```JavaScript
$(document).ready(function(){initNavTree('class_eleon_1_1_modding_1_1_id_structure_block_info.html',''); initResizable(); });
```

--------------------------------

### Get Game State - C#

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_application.html

Retrieves the current game state.

```C#
GameState State { get; }
```

--------------------------------

### Get Entity Name

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_entity.html

Retrieves the name of the entity. This property is read-only.

```C#
string Eleon.Modding.IEntity.Name {
    get;
}
```

--------------------------------

### Initialize Menu and Search Functionality

Source: https://github.com/moicky/empy-docs/blob/main/html/class_eleon_1_1_modding_1_1_chat_msg_data-members.html

Initializes the menu system and search functionality for the documentation. This JavaScript code sets up the interactive elements of the documentation page.

```JavaScript
$(function() { initMenu('',false,false,'search.php','Search'); });
```

--------------------------------

### Get Block Properties

Source: https://github.com/moicky/empy-docs/blob/main/html/interface_eleon_1_1_modding_1_1_i_block-members.html

Retrieves the type, shape, rotation, and active state of a block.

```C#
public void Get(out int type, out int shape, out int rotation, out bool active);
```