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 revisionPrevious revision
Next revision		Previous revision
Last revisionBoth sides next revision
mmoalt_followcommander [2019/11/21 21:58] – [Public API] mmoaltmmoalt_followcommander [2019/11/21 22:50] – [Public API] mmoalt
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.\\ +
- settings = {} Current FollowCommander settings\\ +
- dropDownSettings = {} Values from the drop down list in the gui.\\ +
-}+
  
-''FollowCommanderAPI:Restart()''\\+''FollowCommanderAPI.hasTarget = [boolean]'' \\ 
 +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.\\ Reload all settings, set new random seed values and restart the botmode.\\
  
 ''FollowCommanderAPI:ChangeSetting(key, value)''\\ ''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.\\ 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()''\\ ''FollowCommanderAPI:BlacklistCurrentCommander()''\\
Line 173: Line 181:
  
 ''FollowCommanderAPI:SetFollowType(type)''\\ ''FollowCommanderAPI:SetFollowType(type)''\\
-Sets a new follow type and restarts FollowCommander. Valid types are in FollowCommanderAPI.dropDownSettings .\\+Valid types are in FollowCommanderAPI.dropDownSettings.FollowType.\\
  
 ''FollowCommanderAPI:SetFollowMode(mode)''\\ ''FollowCommanderAPI:SetFollowMode(mode)''\\
-Sets a new follow mode and restarts FollowCommander. Valid modes are in FollowCommanderAPI.dropDownSettings .\\+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.txt · Last modified: 2020/07/02 22:58 by mmoalt

Page Tools