From 1e52affe15fb13e920f8942de998073238be6d01 Mon Sep 17 00:00:00 2001 From: piernov Date: Mon, 9 May 2016 14:05:50 +0200 Subject: Finish Inventory PHPDoc --- doc/phpdoc/packages/inc.html | 368 +++++++++++++++++++++---------------------- 1 file changed, 184 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 c5528a7..b1e32db 100644 --- a/doc/phpdoc/packages/inc.html +++ b/doc/phpdoc/packages/inc.html @@ -252,7 +252,7 @@
  • - \Monster.inc + \Inventory.inc
    • @@ -264,11 +264,11 @@

    Classes, interfaces and traits

    -
    -

    Monster

    -

    Represent an Item in the shop or in the Inventory.

    -
    - « More » +
    +

    Inventory

    +

    Represent the player's Inventory.

    +
    Implemented as a singleton in the session.
    + « More »
    @@ -286,7 +286,7 @@
  • - \craftmine.inc + \dungeon.inc
    • @@ -294,11 +294,53 @@

    Functions

    -
    -

    sendCraftMine

    -

    Sends all data from previous session on page load.

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

    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 »
    @@ -364,26 +406,55 @@
  • - \Inventory.inc + \guild.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 » +
    + +
    -

    Classes, interfaces and traits

    - - -
    -

    Inventory

    -

    Represent the player's Inventory.

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

    Functions

    -
    -

    generateMonster

    -

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

    +
    +

    loadShop

    +

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

    - « More » + « More »
    -
    -

    initDungeon

    -

    Marks the dungeon as accessible in the session.

    +
    +

    getItem

    +

    Gets an Item object from the shop from its name.

    - « More » + « More »
    -
    -

    sendDungeon

    -

    Returns the dungeon array if it was created.

    +
    +

    initShop

    +

    Marks the shop as created in the session.

    - « More » + « 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 » +
    +

    sendShop

    +

    Returns the shop array if it was created.

    +
    + « More »
    -
    -

    launchDungeon

    -

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

    -
    - « 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 »
    -
    -

    sendDungeonProgress

    -

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

    +
    +

    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 »
    -
    -

    exitDungeon

    -

    Marks the dungeon as not accessible in the session.

    +
    +

    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 »
    @@ -584,7 +655,7 @@ sudo chmod g+w data/save
  • - \account.inc + \mine.inc
    • @@ -592,18 +663,25 @@ sudo chmod g+w data/save

    Functions

    -
    -

    debitAccount

    -

    Debits the account of a certain amount of gold.

    +
    +

    initCraftMine

    +

    Initializes the gold amount and miners count in the session.

    - « More » + « More »
    -
    -

    creditAccount

    -

    Credits the account of a certain amount of gold.

    +
    +

    withdrawMine

    +

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

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

    sendMine

    +

    Returns the amount of gold currently owned by the player.

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

    Functions

    -
    -

    loadShop

    -

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

    -
    - « More » -
    - -
    -

    getItem

    -

    Gets an Item object from the shop from its name.

    -
    - « More » +
    +

    sendCraftMine

    +

    Sends all data from previous session on page load.

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

    initShop

    -

    Marks the shop as created in the session.

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

      sendShop

      -

      Returns the shop array if it was created.

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

      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.

    + +
    +

    Functions

    +
    +

    debitAccount

    +

    Debits the account of a certain amount of gold.

    - « 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.

    +
    +

    creditAccount

    +

    Credits the account of a certain amount of gold.

    - « More » + « More »
    @@ -784,101 +859,26 @@ sudo chmod g+w data/save
  • - \guild.inc + \Monster.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

    - - - -
    -

    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.

    -
    - « More » -
    - -
    -

    sendMine

    -

    Returns the amount of gold currently owned by the player.

    +
    +

    Monster

    +

    Represent an Item in the shop or in the Inventory.

    - « More » + « More »
    - - @@ -890,7 +890,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 Sun, 08 May 2016 20:44:21 +0200.
    + generated on Mon, 09 May 2016 14:01:23 +0200.
    -- cgit v1.2.3-54-g00ecf