Difference between revisions of "Faction Documentation"
(→Faction Functions) |
(→Faction Functions) |
||
| Line 18: | Line 18: | ||
! Function Name !! Arguments || Description | ! Function Name !! Arguments || Description | ||
|- | |- | ||
| − | | SetFaction || player,faction,value|| | + | | SetFaction || player,faction,value|| sets faction ranking value on a player |
|- | |- | ||
| − | | AdjustFaction || player,faction,value,cap|| | + | | AdjustFaction || player,faction,value,cap|| either adds or subtracts the faction with cap limitation support. |
|- | |- | ||
| − | | RemoveFaction || player,faction|| | + | | RemoveFaction || player,faction|| removes a faction from a player |
|- | |- | ||
| − | | HasFaction || faction|| | + | | HasFaction || faction|| returns true if the player has a faction |
|- | |- | ||
| − | | GetFactionRank || player,faction|| | + | | GetFactionRank || player,faction|| returns the rank value of a faction from a player |
|} | |} | ||
Revision as of 18:23, 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 |
|---|---|---|
| SetFaction | player,faction,value | sets faction ranking value on a player |
| AdjustFaction | player,faction,value,cap | either adds or subtracts the faction with cap limitation support. |
| RemoveFaction | player,faction | removes a faction from a player |
| HasFaction | faction | returns true if the player has a faction |
| GetFactionRank | player,faction | returns the rank value of a faction from a player |
