Skip to content

Commit

Permalink
docs: added code documentation to lootItemCommand procedure
Browse files Browse the repository at this point in the history
FossilOrigin-Name: dcab1a0a8357b6f7d4e1ade8c5956ada6b9fd8a4e8237bc1f8775b10ea66d27f
  • Loading branch information
thindil committed Jul 31, 2024
1 parent aadc51e commit 4a7ec30
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions nim/src/ui/baseslootui.nim
Original file line number Diff line number Diff line change
Expand Up @@ -355,6 +355,18 @@ proc showLootItemInfoCommand(clientData: cint; interp: PInterp; argc: cint;
proc lootItemCommand(clientData: cint; interp: PInterp; argc: cint;
argv: cstringArray): TclResults {.sideEffect, raises: [], tags: [
RootEffect], exportc.} =
## Take or drop the selected item
##
## * clientData - the additional data for the Tcl command
## * interp - the Tcl interpreter on which the command was executed
## * argc - the amount of arguments entered for the command
## * argv - the list of the command's arguments
##
## The procedure always return tclOk
##
## Tcl:
## LootItem actiontype
## actiontype can be: drop, dropall, take, takeall
var baseCargoIndex, cargoIndex = -1
if itemIndex < 0:
baseCargoIndex = itemIndex.abs
Expand Down

0 comments on commit 4a7ec30

Please sign in to comment.