User Tools

Site Tools



mmoalt_followcommander

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
mmoalt_followcommander [2018/12/01 19:26]
mmoalt
mmoalt_followcommander [2019/11/21 23:50] (current)
mmoalt [Public API]
Line 156: Line 156:
  
 ===== Public API ===== ===== Public API =====
-FollowCommanderAPI = {\\ +''​FollowCommanderAPI = {}''​ 
- ​hasTarget = [true\false] True if currently following, false otherwise.\\ + 
- ​targetID = [nil\number] Character id of the player you are following.\\ +''​FollowCommanderAPI.hasTarget = [boolean]''​ \\ 
- ​settings = {} Current FollowCommander settings\\ +True if currently following, false otherwise.\\ 
-}+ 
 +''​FollowCommanderAPI.targetID = [nil\number]''​ \\ 
 +Character id of the player you are following.\\ 
 + 
 +''​FollowCommanderAPI.settings = [table]''​ \\ 
 +Current FollowCommander settings\\ 
 + 
 +''​FollowCommanderAPI.dropDownSettings = [table]''​ \\ 
 +Values from the drop down list in the gui.\\ 
 + 
 +''​FollowCommanderAPI:​Reload()''​\\ 
 +Reload all settings, set new random seed values and restart the botmode.\\ 
 + 
 +''​FollowCommanderAPI:​ChangeSetting(key,​ value)''​\\ 
 +Change a FollowCommander setting. Valid keys are in FollowCommanderAPI.settings. Value has to be the same type as the old value.\\ 
 +**Settings that have their own function can not be changed with this one.**\\ 
 + 
 +''​FollowCommanderAPI:​BlacklistCurrentCommander()''​\\ 
 +Should be self explainatory.\\ 
 + 
 +''​FollowCommanderAPI:​SetFollowType(type)''​\\ 
 +Valid types are in FollowCommanderAPI.dropDownSettings.FollowType.\\ 
 + 
 +''​FollowCommanderAPI:​SetFollowMode(mode)''​\\ 
 +Valid modes are in FollowCommanderAPI.dropDownSettings.FollowMode.\\ 
 + 
 +''​FollowCommanderAPI:​SetPartyMember(member)''​\\ 
 +Follow a new person when the FollowType is set to "​PartyMember"​. Can be id or name. \\ 
 + 
 +''​FollowCommanderAPI:​SetCombatAggressiveness(aggressiveness)''​\\ 
 +Valid types are in FollowCommanderAPI.dropDownSettings.CombatAggressiveness.\\ 
 + 
 +''​FollowCommanderAPI:​SetWayPointUsage(usage)''​\\ 
 +Valid types are in FollowCommanderAPI.dropDownSettings.WayPointUsage.\\ 
 + 
 +''​FollowCommanderAPI:​SetNoCommanderMode(mode)''​\\ 
 +Valid types are in FollowCommanderAPI.dropDownSettings.NoCommanderMode.\\ 
 + 
 +**All functions that affect settings will call FollowCommanderAPI:​Reload() automatically.** 
mmoalt_followcommander.1543688803.txt.gz · Last modified: 2018/12/01 19:26 by mmoalt