Lua Libraries for Civ5: Difference between revisions

From Civilization Modding Wiki
Jump to navigationJump to search
mNo edit summary
mNo edit summary
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:




== Data persistence ==
= Improving modularity and mods compatibility =
See also [[Persisting data (Civ5)]].
Sometimes mods needs to modify the standard game files in order to achieve some features. Since only one mod can modify a given file a a time, this creates conflicts. Those libraries address those issues: all mods use the same file replacement and this one exposes a way to register new entries and such.
* [http://forums.civfanatics.com/showthread.php?t=442249 TableSaverLoader] from Pazyryk.
{| cellpadding="4"
* [http://forums.civfanatics.com/showthread.php?t=392958 SaveUtils] from Whys.
|-
!Name
!Author
!Description
|-
|valign="top" |[http://forums.civfanatics.com/showthread.php?t=411186 Fully Modifyable Custom Notifications]
|valign="top" |''Sneaks''
|Provides a non-conflicting way for mods to add custom notifications.
|-
|valign="top" |[http://forums.civfanatics.com/showthread.php?p=11394279 Modular Diplo Corner]
|valign="top" |''Whoward69''
|Provides a non-conflicting way for mods to add entries to the diplo corner menu. While Civ5 now offers a similar functionality in standard, this mod still offers the benefit to prevent compatibility issues between updated and outdated mods.
|-
|valign="top" |[http://forums.civfanatics.com/showthread.php?t=458740 Modular Minimap Overlays]
|valign="top" |''Whoward69''
|Provides a non-conflicting way for mods to add entries to the minimap overlays menu.
|-
|valign="top" |[http://forums.civfanatics.com/showthread.php?t=459207 Modular Summary Bar]
|valign="top" |''Whoward69''
|Provides a non-conflicting way for mods to add entries to the topmost bar, near the turn number.
|}
 
 
= Other libraries =
{| cellpadding="4"
|-
!Name
!Author
!Description
|-
|[http://forums.civfanatics.com/showthread.php?t=474634 Border and Area Plot Iterators]
|''Whoward69''
|Provides iterators to enumerate plots in a given range and in different orders.
|-
|[http://forums.civfanatics.com/showthread.php?t=392958 SaveUtils]  
|''Whys''
|Wrappers around the SetScriptData methods (partially deprecated) for conveniency purpose and mods conflicts prevention. See also [[Persisting data (Civ5)]].
|-
|[http://forums.civfanatics.com/showthread.php?t=442249 TableSaverLoader]
|''Pazyryk''
|Saves a Lua table into a custom data table. See also [[Persisting data (Civ5)]].
|}




[[Category:Civ5 API]]
[[Category:Civ5 API]]

Latest revision as of 12:11, 25 September 2012

This page is a part of the Lua and UI Reference.


Improving modularity and mods compatibility

Sometimes mods needs to modify the standard game files in order to achieve some features. Since only one mod can modify a given file a a time, this creates conflicts. Those libraries address those issues: all mods use the same file replacement and this one exposes a way to register new entries and such.

Name Author Description
Fully Modifyable Custom Notifications Sneaks Provides a non-conflicting way for mods to add custom notifications.
Modular Diplo Corner Whoward69 Provides a non-conflicting way for mods to add entries to the diplo corner menu. While Civ5 now offers a similar functionality in standard, this mod still offers the benefit to prevent compatibility issues between updated and outdated mods.
Modular Minimap Overlays Whoward69 Provides a non-conflicting way for mods to add entries to the minimap overlays menu.
Modular Summary Bar Whoward69 Provides a non-conflicting way for mods to add entries to the topmost bar, near the turn number.


Other libraries

Name Author Description
Border and Area Plot Iterators Whoward69 Provides iterators to enumerate plots in a given range and in different orders.
SaveUtils Whys Wrappers around the SetScriptData methods (partially deprecated) for conveniency purpose and mods conflicts prevention. See also Persisting data (Civ5).
TableSaverLoader Pazyryk Saves a Lua table into a custom data table. See also Persisting data (Civ5).