From 4a77dbec06bf7812fa6326cb103dce52144e49c3 Mon Sep 17 00:00:00 2001 From: piernov Date: Tue, 10 May 2016 23:12:04 +0200 Subject: Update phpdoc --- doc/phpdoc/packages/inc.html | 399 +++++++++++++++++++++++-------------------- 1 file changed, 215 insertions(+), 184 deletions(-) (limited to 'doc/phpdoc/packages/inc.html') diff --git a/doc/phpdoc/packages/inc.html b/doc/phpdoc/packages/inc.html index b1e32db..ad993d1 100644 --- a/doc/phpdoc/packages/inc.html +++ b/doc/phpdoc/packages/inc.html @@ -252,7 +252,7 @@
  • - \Inventory.inc + \Monster.inc
    • @@ -264,11 +264,11 @@

    Classes, interfaces and traits

    -
    -

    Inventory

    -

    Represent the player's Inventory.

    -
    Implemented as a singleton in the session.
    - « More » +
    +

    Monster

    +

    Represent an Item in the shop or in the Inventory.

    +
    + « More »
    @@ -286,7 +286,7 @@
  • - \dungeon.inc + \craftmine.inc
    • @@ -294,53 +294,11 @@

    Functions

    -
    -

    generateMonster

    -

    Loads all the dungeon's monsters from the XML file data/monsters.xml.

    -
    - « More » -
    - -
    -

    initDungeon

    -

    Marks the dungeon as accessible in the session.

    -
    - « More » -
    - -
    -

    sendDungeon

    -

    Returns the dungeon array if it was created.

    -
    - « More » -
    - -
    -

    buildDungeon

    -

    Allows acces to the dungeon in the session and sends it to the client.

    -
    Debits the dungeon's ticket cost from the player's gold.
    - « More » -
    - -
    -

    launchDungeon

    -

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    -
    - « More » -
    - -
    -

    sendDungeonProgress

    -

    Updates floor and monster number from the POST parameters in the session.

    -
    - « More » -
    - -
    -

    exitDungeon

    -

    Marks the dungeon as not accessible in the session.

    -
    - « More » +
    +

    sendCraftMine

    +

    Sends all data from previous session on page load.

    +
    All data from the different modules are packed in an array.
    + « More »
    @@ -406,55 +364,26 @@
  • - \guild.inc + \Inventory.inc
    • -
    -

    Functions

    -
    -

    createGuild

    -

    Create the miners guild in the session.

    -
    Debits GUILD_COST from the player's gold.
    - « More » -
    - -
    -

    hireMiner

    -

    Hire one miner.

    -
    Debits MINER_COST from the player's gold.
    - « More » -
    - -
    -

    sendMiners

    -

    Returns the number of miners currently in the guild.

    -
    - « More » -
    - -
    +
    -

    Constants

    -
    -

    GUILD_COST

    -

    Amount of gold required to build the miners guild.

    -
    - « More » -
    - -
    -

    MINER_COST

    -

    Amount of gold required to hire a miner.

    -
    - « More » +

    Classes, interfaces and traits

    + + +
    +

    Inventory

    +

    Represent the player's Inventory.

    +
    Implemented as a singleton in the session.
    + « More »
    - @@ -581,7 +510,7 @@ sudo chmod g+w data/save
  • - \shop.inc + \dungeon.inc
    • @@ -589,53 +518,53 @@ sudo chmod g+w data/save

    Functions

    -
    -

    loadShop

    -

    Loads all the shop's items from the XML file data/items.xml.

    +
    +

    generateMonster

    +

    Loads all the dungeon's monsters from the XML file data/monsters.xml.

    - « More » + « More »
    -
    -

    getItem

    -

    Gets an Item object from the shop from its name.

    +
    +

    initDungeon

    +

    Marks the dungeon as accessible in the session.

    - « More » + « More »
    -
    -

    initShop

    -

    Marks the shop as created in the session.

    +
    +

    sendDungeon

    +

    Returns the dungeon array if it was created.

    - « More » + « More »
    -
    -

    sendShop

    -

    Returns the shop array if it was created.

    -
    - « More » +
    +

    buildDungeon

    +

    Allows acces to the dungeon in the session and sends it to the client.

    +
    Debits the dungeon's ticket cost from the player's gold.
    + « More »
    -
    -

    buildShop

    -

    Creates the shop in the session and sends it to the client.

    -
    Debits the shop's cost from the player's gold.
    - « More » +
    +

    launchDungeon

    +

    Sends monsters for a specific floor as specified by the floor POST parameter to the client.

    +
    + « More »
    -
    -

    buyItem

    -

    Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.

    +
    +

    sendDungeonProgress

    +

    Updates floor and monster number from the POST parameters in the session.

    - « More » + « More »
    -
    -

    useItem

    -

    Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.

    +
    +

    exitDungeon

    +

    Marks the dungeon as not accessible in the session.

    - « More » + « More »
    @@ -655,7 +584,7 @@ sudo chmod g+w data/save
  • - \mine.inc + \account.inc
    • @@ -663,25 +592,18 @@ sudo chmod g+w data/save

    Functions

    -
    -

    initCraftMine

    -

    Initializes the gold amount and miners count in the session.

    -
    - « More » -
    - -
    -

    withdrawMine

    -

    Transfers all gold from the mine to the player's account.

    +
    +

    debitAccount

    +

    Debits the account of a certain amount of gold.

    - « More » + « More »
    -
    -

    sendMine

    -

    Returns the amount of gold currently owned by the player.

    +
    +

    creditAccount

    +

    Credits the account of a certain amount of gold.

    - « More » + « More »
    @@ -701,7 +623,7 @@ sudo chmod g+w data/save
  • - \craftmine.inc + \shop.inc
    • @@ -709,50 +631,53 @@ sudo chmod g+w data/save

    Functions

    -
    -

    sendCraftMine

    -

    Sends all data from previous session on page load.

    -
    All data from the different modules are packed in an array.
    - « More » +
    +

    loadShop

    +

    Loads all the shop's items from the XML file data/items.xml.

    +
    + « More »
    -
    - - - - - -
      -
      • - - - -
    • - \inc -
      • +
      +

      getItem

      +

      Gets an Item object from the shop from its name.

      +
      + « More » +
      - -
    • - \account.inc -
      • +
      +

      initShop

      +

      Marks the shop as created in the session.

      +
      + « More » +
      -
    +
    +

    sendShop

    +

    Returns the shop array if it was created.

    +
    + « More » +
    - -
    -

    Functions

    -
    -

    debitAccount

    -

    Debits the account of a certain amount of gold.

    +
    +

    buildShop

    +

    Creates the shop in the session and sends it to the client.

    +
    Debits the shop's cost from the player's gold.
    + « More » +
    + +
    +

    buyItem

    +

    Debits the item's cost specified as the item POST parameter, adds it to the Inventory and sends it to the client.

    - « More » + « More »
    -
    -

    creditAccount

    -

    Credits the account of a certain amount of gold.

    +
    +

    useItem

    +

    Invoke useItem on an item passed as the item POST parameter, sends to the client the updated player stats and the item.

    - « More » + « More »
    @@ -794,6 +719,30 @@ sudo chmod g+w data/save « More »
    +
    +

    limitUse

    +

    traite le fait que wooden sword n'est pas cumulable +metal sword non plus +life bottle cumulable 3 fois +si on clique sur wooden sword alors que on avait une metal sword, le bonusPower passe de +3 à +1

    +
    + « More » +
    + +
    +

    initUsedItem

    +

    +
    + « More » +
    + +
    +

    reusable

    +

    +
    + « More » +
    +

    updatePerso

    Copies stats given in POST request to session.

    @@ -859,26 +808,108 @@ sudo chmod g+w data/save
  • - \Monster.inc + \guild.inc
    • - +
    +

    Functions

    +
    +

    initMinersIfNeeded

    +

    +
    + « More » +
    + +
    +

    createGuild

    +

    Create the miners guild in the session.

    +
    Debits GUILD_COST from the player's gold.
    + « More » +
    + +
    +

    hireMiner

    +

    Hire one miner.

    +
    Debits MINER_COST from the player's gold.
    + « More » +
    + +
    +

    sendMiners

    +

    Returns the number of miners currently in the guild.

    +
    + « More » +
    + +
    -

    Classes, interfaces and traits

    +

    Constants

    +
    +

    GUILD_COST

    +

    Amount of gold required to build the miners guild.

    +
    + « More » +
    + +
    +

    MINER_COST

    +

    Amount of gold required to hire a miner.

    +
    + « More » +
    + +
    + + + +
      +
      • + -
      -

      Monster

      -

      Represent an Item in the shop or in the Inventory.

      + +
    • + \inc +
      • + + +
    • + \mine.inc +
      • + +
    + + +
    +

    Functions

    +
    +

    initMineIfNeeded

    +

    Initializes the gold amount and miners count in the session.

    - « More » + « More » +
    + +
    +

    withdrawMine

    +

    Transfers all gold from the mine to the player's account.

    +
    + « More » +
    + +
    +

    sendMine

    +

    Returns the amount of gold currently owned by the player.

    +
    + « More »
    + + @@ -890,7 +921,7 @@ sudo chmod g+w data/save Template is built using Twitter Bootstrap 2 and icons provided by Glyphicons.
    Documentation is powered by phpDocumentor and
    - generated on Mon, 09 May 2016 14:01:23 +0200.
    + generated on Tue, 10 May 2016 23:11:53 +0200.
    -- cgit v1.2.3-70-g09d2