Skip to content

Commit

Permalink
chore: Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Panakotta00 committed Oct 26, 2024
1 parent b1464c1 commit bc6ba97
Show file tree
Hide file tree
Showing 119 changed files with 1,883 additions and 200 deletions.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/lua/api/Component.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Component Module
:table-caption!:

Description
The Component Module contains the component Library.

== Globals

Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/lua/api/Computer.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Computer Module
:table-caption!:

Description
The Computer Module provides the Computer Library.

[cols="1,5a",separator="!"]
!===
Expand Down Expand Up @@ -189,7 +189,7 @@ Returns some kind of strange/mysterious time data from a unknown place (the real
====

=== __computer.__**media** : xref:/reflection/classes/FINMediaSubsystem.adoc[FINMediaSubsystem]
Description
Field containing a reference to the Media Subsystem.

=== __computer.__**millis** () -> int
Returns the amount of milliseconds passed since the system started.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/lua/api/Debug.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Debug Module
:table-caption!:

Description


== Globals

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/lua/api/Event.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Event Module
:table-caption!:

Description


== Globals

Expand Down
6 changes: 5 additions & 1 deletion docs/modules/ROOT/pages/lua/api/FileSystem.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
= File-System Module
:table-caption!:

Description
FicsIt-Networks implements it’s own virtual filesystem for UNIX like experience using the FileSystem.
The file system consists of nodes. Such a node can be a File, a Folder or something else. Each nodes is able to have child nodes and might be able to get opened with a file stream. A folder also delivers an abstract interface for adding and removing nodes. A Device implements lookup functions for searching for nodes in the filesystem structure. Such a device can be a temporary filesystem (tmpfs) which exists only in memory and which will get purged on a system reboot, or f.e. a disk filesystem (drives) which store the nodes on the real virtual filesystem in a folder. You can then mount such a device to a location in the root filesystem tree so when you now access a path, the filesystem looks first for the device and uses then the remaining path to get the node data from the device.
There is also a DriveNode which simply holds a reference to a drive so you can access a drive via the filesystem. You can use then the mount function to mount the Drive of a DriveNode to the given location in the filesystem tree.
Because you need at least one drive mounted to even be able to access any node, we provide the initFileSystem function which you can call only once in a system session. This functions will then mount the DevDevice to the given location.
The DevDevice is a sepcial Device which holds all the DeviceNodes representing Device attached to the computer session, like hard drives, tempfs and the serial I/O.

== Globals

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/lua/api/FutureModule.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Future Module
:table-caption!:

Description
This Module provides the Future type and all its necessary functionallity.

== Types

Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/lua/api/ModuleSystem.adoc
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
= Module-System Module
:table-caption!:

Description


== Types

=== **ModuleTableFunction**


=== __ModuleTableFunction.__**description** : string
Description


=== __ModuleTableFunction.__**displayName** : string
Description


=== __ModuleTableFunction.__**name** : string
Description


=== __ModuleTableFunction.__**quickRef** : string
Description


10 changes: 7 additions & 3 deletions docs/modules/ROOT/pages/lua/api/ReflectionSystemBaseModule.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Reflection-System Base Module
:table-caption!:

Description
This Module provides common functionallity required by further reflection related modules.

== Types

Expand All @@ -12,8 +12,12 @@ Instead of just calling it, you can also ask for information about the function
And it makes debugging a bit easier.

=== __ReflectionFunction.__**asFunctionObject** : xref:/reflection/classes/Function.adoc[Function]
Description
Returns the Reflection-System Object that represents this Reflected Function.
This way you can deeply inspect the function and its associations.

=== __ReflectionFunction.__**callDeferred** : function
Calls the function deferred in the next tick. Returns a Future to allow check for execution and get the return parameters.

=== __ReflectionFunction.__**quickRef** : string
Description
A string containing the signature and description of the function for quick way to get info one the function within code.

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Reflection-System Class Module
:table-caption!:

Description
This module provides all the functionallity for the usage of Types/Classes from the reflection system in Lua.

[cols="1,5a",separator="!"]
!===
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Reflection-System Object Module
:table-caption!:

Description
This module provides all the functionallity for the usage of objects from the reflection system in Lua.

[cols="1,5a",separator="!"]
!===
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= Reflection-System Struct Module
:table-caption!:

Description
This module provides all the functionallity for the usage of reflected structs in Lua.

[cols="1,5a",separator="!"]
!===
Expand Down
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/reflection/classes/Actor.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
= Actor
:table-caption!:

[cols="1,5a",separator="!"]
!===
! Parent
! xref:/reflection/classes/Object.adoc[Object]
!===

This is the base class of all things that can exist within the world by them self.

// tag::interface[]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
= Actor Component
:table-caption!:

[cols="1,5a",separator="!"]
!===
! Parent
! xref:/reflection/classes/Object.adoc[Object]
!===

A component/part of an actor in the world.

// tag::interface[]
Expand Down
6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/reflection/classes/ArrayProperty.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
= Array Property
:table-caption!:

[cols="1,5a",separator="!"]
!===
! Parent
! xref:/reflection/classes/Property.adoc[Property]
!===

A reflection object representing a array property.

// tag::interface[]
Expand Down
122 changes: 122 additions & 0 deletions docs/modules/ROOT/pages/reflection/classes/BasicSubplate_2x2.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
= Basic Subplate 2x2
:table-caption!:

[cols="1,5a",separator="!"]
!===
! Parent
! xref:/reflection/classes/Buildable.adoc[FINModuleBase]
!===

This subplate allows one to place a single module in the center of a 2x2 module grid.



// tag::interface[]

== Functions

// tag::func-getModules-title[]
=== `getModules` () -> `modules` : Array<Object<xref:/reflection/classes/Object.adoc[Object]>>
// tag::func-getModules[]

Returns all the modules on this subplate

[%collapsible]
====
[cols="1,5a",separator="!"]
!===
! Flags
! +++<span style='color:#bb2828'><i>RuntimeSync</i></span> <span style='color:#bb2828'><i>RuntimeParallel</i></span> <span style='color:#5dafc5'><i>MemberFunc</i></span>+++
! Display Name ! Get Modules
!===
.Return Values
[%header,cols="1,1,4a",separator="!"]
!===
!Name !Type !Description
! *modules* `modules`
! Array<Object<xref:/reflection/classes/Object.adoc[Object]>>
!
!===
====
// end::func-getModules[]
// end::func-getModules-title[]
// tag::func-getSubModule-title[]
=== `getSubModule` () -> `Module` : Object<xref:/reflection/classes/Actor.adoc[Actor]>
// tag::func-getSubModule[]

Returns the module associated with this subplate.
This is effectively the same as calling getModule(0,0)

[%collapsible]
====
[cols="1,5a",separator="!"]
!===
! Flags
! +++<span style='color:#bb2828'><i>RuntimeSync</i></span> <span style='color:#bb2828'><i>RuntimeParallel</i></span> <span style='color:#5dafc5'><i>MemberFunc</i></span>+++
! Display Name ! Get Sub Module
!===
.Return Values
[%header,cols="1,1,4a",separator="!"]
!===
!Name !Type !Description
! *Module* `Module`
! Object<xref:/reflection/classes/Actor.adoc[Actor]>
!
!===
====
// end::func-getSubModule[]
// end::func-getSubModule-title[]
// tag::func-getModule-title[]
=== `getModule` (`X` : Int, `Y` : Int) -> `Module` : Object<xref:/reflection/classes/Actor.adoc[Actor]>
// tag::func-getModule[]



[%collapsible]
====
[cols="1,5a",separator="!"]
!===
! Flags
! +++<span style='color:#bb2828'><i>RuntimeSync</i></span> <span style='color:#bb2828'><i>RuntimeParallel</i></span> <span style='color:#5dafc5'><i>MemberFunc</i></span>+++
! Display Name ! getModule
!===
.Parameters
[%header,cols="1,1,4a",separator="!"]
!===
!Name !Type !Description
! *X* `X`
! Int
!
! *Y* `Y`
! Int
!
!===
.Return Values
[%header,cols="1,1,4a",separator="!"]
!===
!Name !Type !Description
! *Module* `Module`
! Object<xref:/reflection/classes/Actor.adoc[Actor]>
!
!===
====
// end::func-getModule[]
// end::func-getModule-title[]

// end::interface[]

22 changes: 14 additions & 8 deletions docs/modules/ROOT/pages/reflection/classes/BigGaugeModule.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
= Big Gauge Module
:table-caption!:

[cols="1,5a",separator="!"]
!===
! Parent
! xref:/reflection/classes/Buildable.adoc[FINModuleBase]
!===

A medium analogue Gauge for use on Large Panels. The red portion and needle position can be changed through FIN

// tag::interface[]
Expand Down Expand Up @@ -45,7 +51,7 @@ A medium analogue Gauge for use on Large Panels. The red portion and needle posi
== Functions

// tag::func-setBackgroundColor-title[]
=== `setBackgroundColor` (`red` : Float, `green` : Float, `blue` : Float, `Emit` : Float)
=== `setBackgroundColor` (`Red` : Float, `Green` : Float, `Blue` : Float, `Emit` : Float)
// tag::func-setBackgroundColor[]


Expand All @@ -65,15 +71,15 @@ A medium analogue Gauge for use on Large Panels. The red portion and needle posi
!===
!Name !Type !Description
! *red* `red`
! *Red* `Red`
! Float
!
! *green* `green`
! *Green* `Green`
! Float
!
! *blue* `blue`
! *Blue* `Blue`
! Float
!
Expand All @@ -86,7 +92,7 @@ A medium analogue Gauge for use on Large Panels. The red portion and needle posi
// end::func-setBackgroundColor[]
// end::func-setBackgroundColor-title[]
// tag::func-setColor-title[]
=== `setColor` (`red` : Float, `green` : Float, `blue` : Float, `Emit` : Float)
=== `setColor` (`Red` : Float, `Green` : Float, `Blue` : Float, `Emit` : Float)
// tag::func-setColor[]


Expand All @@ -106,15 +112,15 @@ A medium analogue Gauge for use on Large Panels. The red portion and needle posi
!===
!Name !Type !Description
! *red* `red`
! *Red* `Red`
! Float
!
! *green* `green`
! *Green* `Green`
! Float
!
! *blue* `blue`
! *Blue* `Blue`
! Float
!
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
= Speaker-Pole
:table-caption!:

[cols="1,5a",separator="!"]
!===
! Parent
! xref:/reflection/classes/SpeakerPole.adoc[SpeakerPole]
!===

The FicsIt-Networks speaker pole is a network component which allows you to use one more sense of the pioneers to give commands to them or to just make ambient better.

The speaker pole can play sound files located in the Computer Folder "/Sounds" in your Satisfactory Save-Games-Folder. The FicsIt-Networks speaker pole is only able to play .ogg files cause FicsIt Inc. has the opinion other file formates are useless.
Expand Down
Loading

0 comments on commit bc6ba97

Please sign in to comment.