1. We have added a Gift Upgrades feature that allows you to gift an account upgrade to another member, just in time for the holiday season. You can see the gift option when going to the Account Upgrades screen, or on any user profile screen.
    Dismiss Notice

[Python] API Documentation Tool

Discussion in 'Civ4 - SDK/Python' started by EmperorFool, Aug 24, 2008.

  1. EmperorFool

    EmperorFool Deity

    Joined:
    Mar 2, 2007
    Messages:
    9,633
    Location:
    Mountain View, California

    I have updated Locutus's script that generates HTML documentation and put it on Google Code for further development.


    It works just like it did before: copy genHTML.py and z_API_files to your Beyond the Sword install directory and run the script.
     
  2. Dresden

    Dresden Emperor

    Joined:
    Jul 10, 2008
    Messages:
    1,081
    :bump:

    EF recently fixed a problem with generating the Type lists and then I went through and updated it with all the non-SDK BTS-changes that are documented in pydoc along with a tweak or two. It's not totally complete as there was some other stuff EF was working on (CvDiplomacyResponse, Response, and WidgetAnim) that is not in pydoc and I can't even find in the Python, but there are over 150 changes from the initial BTS version so it's time for an update.

    For a current version of the generator script, just check it out from the repository.

    For a current version of the documentation itself, grab the attached zipfile since it doesn't yet have an online home.

    In the spoiler are the list of non-SDK BTS changes included in the update
    Spoiler :
    Code:
    2008-10-10 - Updated for BTS (3.17) including most non-SDK changes.
    
    Changes in non-SDK classes from Warlords v2.00 to BTS v3.17 (legend: (a) = added, (r) = removed, (m) = modified):
    
        * In CyEngine:
          (a) void clearAreaBorderPlots(int)
          (a) void fillAreaBorderPlot(...)
          (a) void fillAreaBorderPlotAlt(...)
          (a) bool getCultureVisibility()
          (a) void setCultureVisibility(bool)
    
        * In CyGInterfaceScreen:
          (r) void addBonusGraphic(...)
          (r) void addBorderedPane(...)
          (r) void addBuildingGraphic(...)
          (m) void addCheckBoxGFCAt(...)
          (r) void addDDS(...)
          (r) void addDropDownBox(...)
          (r) void addEditBox(...)
          (r) void addFlagWidget(...)
          (m) void addFlagWidgetGFC(...)
          (r) void addGraphic(...)
          (r) void addImprovementGraphic(...)
          (r) void addLeaderhead(...)
          (r) void addLine(...)
          (r) void addListBox(...)
          (r) void addListBoxString(...)
          (a) void addModelGraphicGFC(...)
          (r) void addPane(...)
          (r) void addPlotGraphic(...)
          (r) void addProjectGraphic(...)
          (m) void addPullDownString(...)
          (a) void addSpaceShipWidgetGFC(...)
          (a) void addSpecificUnitGraphicGFC(...)
          (r) void addStackedBar(...)
          (a) void addStackedBarGFCAt(...)
          (a) void addTableControlGFCWithHelp(...)
          (a) void addToModelGraphicGFC(...)
          (r) void addUnitGraphic(...)
          (r) void addWorldWidget(...)
          (r) void appendText(...)
          (a) void appendListBoxStringNoUpdate(...)
          (r) void attachScrollbarToDropDown(...)
          (r) void attachScrollbarToListBox(...)
          (a) void attachSeparator(...)
          (r) void attachText(...)
          (a) void changeModelGraphicTextureGFC(...)
          (r) int findXPoint(...)
          (r) int findYPoint(...)
          (r) void getScrollableAreaCurrentX(...)
          (r) void getScrollableAreaCurrentY(...)
          (r) void getScrollbarCurrentStop(...)
          (r) void getSelectedListBoxID(...)
          (r) void getSelectedListBoxString(...)
          (r) void getTextRightEdge(...)
          (r) void groupRadioButton(...)
          (r) void hasExitButton(...)
          (r) void hiderange(...)
          (r) void highlightDDS(...)
          (a) void leaderheadKeyInput(...)
          (r) void modifyWidgetData(...)
          (r) void parentClick(...)
          (r) void resizeBorderedPane(...)
          (r) void resizePane(...)
          (r) void scrollableAreaScrollDown(...)
          (r) void scrollableAreaScrollLeft(...)
          (r) void scrollableAreaScrollRight(...)
          (r) void scrollableAreaScrollToBottom(...)
          (r) void scrollableAreaScrollToTop(...)
          (r) void scrollableAreaScrollUp(...)
          (r) void setAnimation(...)
          (r) void setBackgroundBorderedPane(...)
          (r) void setBackgroundWidget(...)
          (r) void setButton(...)
          (r) void setButtonText(...)
          (r) void setCheckBox(...)
          (r) void setDataElement(...)
          (r) void setDropDownColors(...)
          (r) void setExitButton(...)
          (r) void setFittedText(...)
          (r) void setLeftText(...)
          (r) void setListBoxColors(...)
          (a) void setMinimapSectionOverride(...)
          (a) void setModelGraphicRotationRateGFC(...)
          (r) void setNamedScrollableAreaHorizontalScrollbar(...)
          (r) void setNamedScrollableAreaVerticalScrollbar(...)
          (r) void setPaneColor(...)
          (r) void setPassThru(...)
          (r) void setPulsing(...)
          (r) void setRadioButton(...)
          (r) void setRadioButtonState(...)
          (r) void setRightText(...)
          (r) void setScale(...)
          (r) void setScrollableArea(...)
          (r) void setScrollableAreaDimensions(...)
          (r) void setScrollableAreaHorizontalScrollbar(...)
          (r) void setScrollableAreaPaneColor(...)
          (r) void setScrollableAreaVerticalScrollbar(...)
          (r) void setScrollbar(...)
          (r) void setScrollbarNumStops(...)
          (r) void setScrollbarToStop(...)
          (r) void setSelectedListBoxString(...)
          (a) void setSpaceShip(ProjectType)
          (a) bool spaceShipCanChangeType(ProjectTypes)
          (a) void spaceShipChangeType(ProjectTypes)
          (a) void spaceShipFinalize()
          (a) void spaceShipLaunch()
          (a) void spaceShipZoom(ProjectTypes)
          (r) void setTextBackgroundPane(...)
          (r) void setTextColor(...)
          (r) void setTextHighlightColor(...)
          (a) void updateListBox(...)
    
        * In CyInterface:
          (m) void DoSoundtrack(string)
          (a) void addQuestMessage(PlayerTypes, string)
          (a) void cacheInterfacePlotUnits(CyPlot)
          (a) void exitingToMainMenu(string)
          (a) CyUnit getCachedInterfacePlotUnit(int)
          (a) CyPlot getGotoPlot()
          (a) int getNumCachedInterfacePlotUnits()
          (r) CyUnit getSelectionPlotUnit()
          (a) bool isFocusedWidget()
          (a) bool isInAdvancedStart()
          (a) bool isScoresMinimized()
          (a) void playGeneralSoundAtPlot(int, CyPlot)
          (a) void setBusy(bool)
          (a) void setInterfaceMode(InterfaceModeTypes)
          (a) void toggleScoresMinimized()
    
        * In CyInterfaceScreen:
          Entire class has been removed
    
        * In CyMessageControl:
          (a) void sendAdvancedStartAction(...)
          (a) void sendDoTask(...)
          (a) void sendEmpireSplit(PlayerTypes, int)
          (a) void sendEspionageSpendingWeightChange(TeamTypes, int)
          (a) void sendModNetMessage(int, int, int, int, int)
          (a) void sendTurnComplete()
    
        * In CyPopupInfo:
          (a) string getPythonModule()
          (a) void setPythonModule(string)
    
        * In CyUnitEntity:
          (r) float GetFacingDirection()
          (r) void SetFacingDirection(...)
    
        * In CyUserProfile:
          (a) int getGlobeLayer()
          (a) bool getGrid()
          (a) int getMainMenu()
          (a) bool getMap()
          (a) int getMovieQualityLevel()
          (a) bool getScores()
          (a) bool getYields()
          (a) void setMainMenu(int)
          (a) void setMovieQualityLevel(int)
    
     

    Attached Files:

  3. EmperorFool

    EmperorFool Deity

    Joined:
    Mar 2, 2007
    Messages:
    9,633
    Location:
    Mountain View, California
    Thanks for the update and fixing up the HTML changelog, Dresden. :goodjob:

    I have put the API online at BUG's web space until we can find a permanent home for it.
     
  4. stmartin

    stmartin aka. poyuzhe

    Joined:
    Aug 4, 2007
    Messages:
    640
    Location:
    Shanghai
    That's cool man :)
     

Share This Page