Technische Dokumentation: Klassen + Funktionen

[Chrissi]

• checkmail($arg)
  
• reload_map
  
• logging($arg,$arg)
  
• parse($arg)
  
• entparse($arg)
  
• get_ms($arg)
  
• format_number($arg)
  
• getfirstvillage($userid)
  Liefert das erste Dorf des Spielers($userid) zurück. Nach ABC geordnet
  

• create_village($userid,$username='',$direction)
  Erstellt ein neues Dorf, die Userid gilt als Besitzer
  (für Flülas -1) aus der Variablen $ username ergibt sich der Dorfname und als Direction wird die Aurichtung (nw,sw,no,so,random) angegeben.
  

• convert_to_continents($x, $y)
  Liefert mit den x-Koords und den $y-Koords den Kontinent
  als Array (Array ( [con] => 54 [sec] => 0 => 0 ) 0)
  

• stage($arg)
  
• format_time($timestamp)
  Wandelt die angegebenen Sekunden in HH:MM:SS um.
  Also echo format_time('3600') = 1:00:00
  

• format_date($timestamp)
  
• ressis($vid)
  Liefert einen Array mit den Ressis des Dorfes ($vid)
  

• generate_key
  
• send_mail($arg,$arg,$arg,$arg,$arg,$arg,$arg)
  
• reload_village_points($vid)
  
• reload_all_village_points($arg)
  
• reload_player_points($pid)
  
• reload_all_player_points($arg)
  
• reload_ally_points($aid)
  
• reload_all_ally_points($arg)
  
• load_bh($arg)
  
• reload_ally_rangs()
  
• reload_player_rangs()
  
• reload_kill_player()
  
• unit_running - - - - - - - - - - fünf Argumente
  
• simulate - - - - - - - - - - fünf Argumente
  
• add_movement - - - - - - - - - - neun Argumente
  
• get_movement_message - - - - - - - - - - drei Argumente
  
• calc_moral - - - - - - - - - - 2 Argumente
  
• calc_agreement - - - - - - - - - - ein Argument
  
• get_dealers - - - - - - - - - - ein Argument
  
• get_ratio_red - - - - - - - - - - ein Argument
  
• get_ratio_green - - - - - - - - - - ein Argument
  
• assume_offer - - - - - - - - - - sieben Argumente
  
• send_dealers - - - - - - - - - - 12 Argumente
  
• add_allyevent - - - - - - - - - - 2 Argumente
  
• check_recruit - - - - - - - - - - 2 Argumente
  
• check_builds - - - - - - - - - - 1 Argument
  
• check_tech - - - - - - - - - - 1 Argument
  
• check_dealers - - - - - - - - - - 2 Argumente
  
• do_movement - - - - - - - - - - 3 Argumente
  
• do_movement_back - - - - - - - - - - 1 Argument
  
• do_movement_return - - - - - - - - - - 1 Argument
  
• do_movement_attack - - - - - - - - - - 3 Argumente
  
• do_movement_support - - - - - - - - - - 1 Argument
  
• check_events - - - - - - - - - - 1 Argument
  

• Klasse: db_mysql()
  
  1. connect
     
  2. disconnect
     
  3. query
     
  4. unb_query
     
  5. numqueries
     
  6. write_ms
     
  7. lasterror
     
  8. affectedrows
     
  9. __destruct
     
  10. fetch
      
  11. freeresult
      
  12. numrows
      
  13. getlastid
      

• Klasse: getvillagedata()
  
  1. getvillagedata
     
  2. getbyid($vid,$arr)
     Diese Funktion braucht die Villageid und einen Array der folgendes enthalten könnte:
     $new = array(0=>"main,barracks,place");
     Die Funktion sieht dann so aus ->getvillagedata(1,$new);
     Zurückgeliefert bekommt man einen Array der so aussieht
     Array ( [exist_village] => 1 [main] => 10 [barracks] => 10 [place] => 1 )
     (Natürlich sehen die Stufen immer unterschiedlich aus)
  
  

• Klasse: getuserdata()
  
  1. getuserdata
     
  2. getbyid - - - - - - - - - - 2 Argumente
     
  3. getbyusername - - - - - - - - - - 2 Argumente
     

• Klasse: login()
  
  1. login_do - - - - - - - - - - 3 Argument
     
  2. login_uv - - - - - - - - - - 1 Argument
     
  3. try_login - - - - - - - - - - 2 Argument
     
  4. getuserdata()
     
  5. getbyid - - - - - - - - - - 2Argument
     
  6. getbyusername - - - - - - - - - - 2 Argument
     
  7. login()

• Klasse: sid()
  
  1. sid()
     
  2. create_sid - - - - - - - - - - 1 Argument
     
  3. logout - - - - - - - - - - 1 Argument
     
  4. check_sid - - - - - - - - - - 1 Argument
     
  5. is_vacation

• Klasse: map()
  
  1. map()
     
  2. search_villages - - - - - - - - - - 4 Argumente
     
  3. getvillage - - - - - - - - - - 2 Argumente
     
  4. getuser - - - - - - - - - - 2 Argumente
     
  5. getcolor - - - - - - - - - - 2 Argumente
     
  6. graphic - - - - - - - - - - 2 Argumente
     
  7. getclass - - - - - - - - - - 2 Argumente
     
  8. getcon - - - - - - - - - - 2 Argumente
     
  9. getvillageid - - - - - - - - - - 2 Argumente
     
  10. getally - - - - - - - - - - 2 Argumente
      
  11. playerinfo - - - - - - - - - - 2 Argumente
      

• Klasse: builds()
  
  1. builds
     
  2. add_build($dtname,$ename)
     Erstellt eine neues Gebäude. Deutscher und Englischer Name sind die Parameter.
     
     
  3. set_woodprice($woodprice,$pro)
     
  4. set_stoneprice($stoneprice,$pro)
     
  5. set_ironprice($ironprice,$pro)
     
  6. set_points($points,$pro)
     
  7. set_time($time,$pro)
     Setzt die Zeit fest bis ein Gebäude fertig ist - mit prozentualen Anstieg
     
     
  8. set_mainfactor
     
  9. set_maxstage($stage)
     Setzt die maximale Ausbaustufe fest ($stage)
     
     
  10. set_buildsharpens
      
  11. set_bhprice($bh,$pro)
      Setzt den Bauernhofpreis fest - prozentualer Anstieg
      
      
  12. set_description
      Setzt eine Beschreibung fest
      
      
  13. set_needbuilds(array($building =>$stufe))
      $building = Gebäude (englischer Name) $stufe = benötigte Ausbaustufe
      
      
  14. set_specials(array($kp))
      
  15. get_array
      
  16. get_needed
      
  17. get_needed_by_dbname
      
  18. get_specials
      
  19. get_dbname
      
  20. get_name($building)
      Liefert den deutschen Namen zurück
      
      
  21. get_description
      
  22. get_description_bydbname
      
  23. get_maxstage($building)
      Liefert die höchste Stufe zurück
      
      
  24. get_wood($building,$stage)
      Liefert den Holzpreis für die Stufe ($stage) zurück.
      
      
  25. get_stone($building,$stage)
      Liefert den Lehmpreis für die Stufe ($stage) zurück.
      
      
  26. get_iron($building,$stage)
      Liefert den Eisenpreis für die Stufe ($stage) zurück.
      
      
  27. get_bh($building,$stage)
      Liefert die Bauernhofplätze zurück die das Gebäude mit der Stufe braucht.
      
      
  28. get_bh_total
      
  29. get_points($building,$stage)
      Liefert die Punkte zurück die dieses Gebäude mit der Stufe bringt
      
      
  30. get_time
      
  31. get_highest_stage
      
  32. build($village,$building,$build_village,$plus_costs)
      $building => gebäude, das gebaut wird (englisch!!!)
      $village => Dörferinfos + aktuelle Gebäudestufen
      $build_village => Gebäudestufe mit Warteschleife und in Bau, das heißt, Holz ist auf Stufe 3 und in der schleife ist 2x holz, so steht in dem array unter anderem: wood=>5
      $plus_costs => Prozente der zusätzlichen Kosten
      siehe get_buildsharpens_costs
      
      
  33. check_needed
      
  34. get_build_error
      
  35. get_build_error2
      
  36. get_buildsharpens_costs($auftrag,$minus_auftrag=true)
      $auftrag => Wie viele Aufträge gibts schon,also 3 Aufträge => $auftrag=3;
      $minus_auftrag muss auf TRUE SEIN!!!!
      

• Klasse: units()
  
  1. units
     
  2. add_unit
     
  3. set_needed
     
  4. set_woodprice
     
  5. set_stoneprice
     
  6. set_ironprice
     
  7. set_bhprice
     
  8. set_time
     
  9. set_att
     
  10. set_group
      
  11. set_def
      
  12. set_defcav
      
  13. set_speed
      
  14. set_booty
      
  15. set_col
      
  16. set_recruit_in
      
  17. set_unitfactor
      
  18. set_specials
      
  19. get_array
      
  20. get_lowest_unit
      
  21. get_recruit_in_units
      
  22. get_col
      
  23. get_speed()
      Erwartet keine Argumente. Liefert einen Array zurück.
      Bsp. (( [unit_spear] => 720 [unit_sword] => 900 [unit_axe] => 720 [unit_spy] => 360 [unit_light] => 390 [unit_heavy] => 450 [unit_ram] => 1200 [unit_catapult] => 1440 [unit_snob] => 1800 ))
      
      
  24. check_needed($unit,$vid)
      Überprüft ob die Einheit($unit) im Dorf($vid) gebaut werden kann.
      Fehler können über die Variable(!) last_error in der gleichen Klasse abgefragt werden.
      
      
  25. recruit_units($name,$count,$building,$building_stage,$villageid)
      $name => einhteitenname
      $count => anzahl
      $building => kaserne,...
      $building_stage => stufe der kaserne,...
      $villageid => Dorfid
      
      
  26. read_units
      
  27. get_woodprice($unit)
      Liefert eine Variable mit den Holzpreis der Einheit $unit
      
      
  28. get_stoneprice($unit)
      Liefert eine Variable mit den Lehmpreis der Einheit $unit
      
      
  29. get_ironprice($unit)
      Liefert eine Variable mit den Eisenpreis der Einheit $unit
      
      
  30. get_specials
      
  31. get_needed($unit)
      Liefert einen Array mit den Gebäudeanforderungen
      
      
  32. get_countneeded
      
  33. get_bhprice
      Liefert eine Variable mit den Plätzen des Bauernhofes die diese Einheit($unit) belegt
      
      
  34. get_group
      Liefert eine Variable mit der Gruppe der Einheit($unit)
      
      
  35. get_time
      
  36. get_name
      Liefert eine Variable mit den deutschen Namen der Einheit($unit)
      
      
  37. get_booty
      
  38. get_graphicname
      
  39. get_att
      
  40. get_def
      
  41. get_defcav

• Klasse: techs()
  
  1. techs
     
  2. add_tech
     
  3. set_woodprice
     
  4. set_stoneprice
     
  5. set_ironprice
     
  6. set_time
     
  7. set_smithfactor
     
  8. set_maxstage
     
  9. set_needed
     
  10. set_group
      
  11. set_description
      
  12. check_tech
      
  13. research
      
  14. get_last_error
      
  15. get_graphic
      
  16. get_time_wait
      
  17. get_dbname
      
  18. get_name
      
  19. get_maxstage
      
  20. get_wood
      
  21. get_stone
      
  22. get_iron
      
  23. get_time
      
  24. get_factor
      
  25. get_group
      
  26. get_array
      
  27. get_needed
      
  28. get_tech_from_village

• Klasse: ramharm()
  
  1. set_factor
     
  2. get_builddeff

• Klasse: catapultharm()
  
  1. set_factor
     
  2. get_builddeff

• Klasse: add_report()
  
  1. new_report
     
  2. support
     
  3. attack
     
  4. support_attack
     
  5. sendress
     
  6. assume_offer
     
  7. ally_invite
     
  8. ally_cancel_invite
     
  9. ally_close
     
  10. accept_uv
      
  11. inquires_uv
      
  12. reject_uv
      
  13. cancel_uv
      
  14. attack_ally_visit

• Klasse: do_action()
  
  1. do_action
     
  2. close
     
  3. open
     
  4. close_new
     
  5. open_new

Allgemeine Parameter:
$pro = Prozentsatz
$woodprice = Holzpreis
$stoneprice = Lehmpreis
$ironprice = Eisenpreis
$unit = Einheit Bsp. unit_spear
$points = Punkte
$arg = Argument (bei einer Genaueren Beschreibung wird dieses Argument ersetzt)

[pL4n3]

In Kürze wird eine genaue Dokumentation von Funktionen + Klassen geben, die aktuelle Dokumentation ist so gerade ausreichend