Difference between revisions of "Faction Documentation"
| Line 2: | Line 2: | ||
==About Factions== | ==About Factions== | ||
Some games you player have a faction system to keep track of your reputation or standing with a group of in game npcs, towns, villages or even that rambling drunk who may have that rusty key your looking for. I have created a simple easy to upgrade system as a starting point for any developer to easily merge and create factions for their players to join and work with. | Some games you player have a faction system to keep track of your reputation or standing with a group of in game npcs, towns, villages or even that rambling drunk who may have that rusty key your looking for. I have created a simple easy to upgrade system as a starting point for any developer to easily merge and create factions for their players to join and work with. | ||
| + | ==Faction Scripts== | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! File Name !! Description | ||
| + | |- | ||
| + | | systems_factions.lua || core functions for the faction system | ||
| + | |- | ||
| + | | systems_factions_window.lua || faction display window for players | ||
| + | |- | ||
| + | | systems_factions_window_handler.lua || handles the button responses to the faction window | ||
| + | |} | ||
| + | ==Faction Functions== | ||
| + | {| class="wikitable" | ||
| + | |- | ||
| + | ! Function Name !! Arguments || Description | ||
| + | |- | ||
| + | | Example || Example || | ||
| + | |- | ||
| + | | Example || Example || | ||
| + | |- | ||
| + | | Example || Example || | ||
| + | |- | ||
| + | | Example || Example || | ||
| + | |- | ||
| + | | Example || Example || | ||
| + | |} | ||
Revision as of 18:18, 18 June 2018
back to Project Phoenix#Factions
About Factions
Some games you player have a faction system to keep track of your reputation or standing with a group of in game npcs, towns, villages or even that rambling drunk who may have that rusty key your looking for. I have created a simple easy to upgrade system as a starting point for any developer to easily merge and create factions for their players to join and work with.
Faction Scripts
| File Name | Description |
|---|---|
| systems_factions.lua | core functions for the faction system |
| systems_factions_window.lua | faction display window for players |
| systems_factions_window_handler.lua | handles the button responses to the faction window |
Faction Functions
| Function Name | Arguments | Description |
|---|---|---|
| Example | Example | |
| Example | Example | |
| Example | Example | |
| Example | Example | |
| Example | Example |
