Added luadocs for core.* functions

git-svn-id: http://svn.net-core.org/repos/t-engine4@2334 51575b47-30f0-44d4-a5cc-537603b46e54

@@ -787,14 +787,14 @@ function _M:setupCommands()
 --		HOTKEY_HOTPAGE3 = function(sym, ctrl, shift, alt, meta, unicode, isup) self.player:setHotkeyPage(isup and 1 or 3) end,
 
 		-- Party commands
-		SWITCH_PARTY_1 = not_wild(function() self.party:setPlayer(1) end),
-		SWITCH_PARTY_2 = not_wild(function() self.party:setPlayer(2) end),
-		SWITCH_PARTY_3 = not_wild(function() self.party:setPlayer(3) end),
-		SWITCH_PARTY_4 = not_wild(function() self.party:setPlayer(4) end),
-		SWITCH_PARTY_5 = not_wild(function() self.party:setPlayer(5) end),
-		SWITCH_PARTY_6 = not_wild(function() self.party:setPlayer(6) end),
-		SWITCH_PARTY_7 = not_wild(function() self.party:setPlayer(7) end),
-		SWITCH_PARTY_8 = not_wild(function() self.party:setPlayer(8) end),
+		SWITCH_PARTY_1 = not_wild(function() self.party:select(1) end),
+		SWITCH_PARTY_2 = not_wild(function() self.party:select(2) end),
+		SWITCH_PARTY_3 = not_wild(function() self.party:select(3) end),
+		SWITCH_PARTY_4 = not_wild(function() self.party:select(4) end),
+		SWITCH_PARTY_5 = not_wild(function() self.party:select(5) end),
+		SWITCH_PARTY_6 = not_wild(function() self.party:select(6) end),
+		SWITCH_PARTY_7 = not_wild(function() self.party:select(7) end),
+		SWITCH_PARTY_8 = not_wild(function() self.party:select(8) end),
 		SWITCH_PARTY = not_wild(function() self:registerDialog(require("mod.dialogs.PartySelect").new()) end),
 
 		-- Actions

@@ -20,6 +20,7 @@
 require "engine.class"
 require "engine.Entity"
 local Map = require "engine.Map"
+local PartyOrder = require "mod.dialogs.PartyOrder"
 
 module(..., package.seeall, class.inherit(
 	engine.Entity
@@ -165,3 +166,67 @@ function _M:findSuitablePlayer(type)
 	end
 	return false
 end
+
+function _M:canOrder(actor, order, vocal)
+	if not actor then return false end
+	if actor == game.player then return false end
+
+	if not self.members[actor] then
+--		print("[PARTY] error trying to order, not a member of party: ", actor.uid, actor.name)
+		return false
+	end
+	if self.members[actor].control ~= "full" or self.members[actor].control ~= "order" or not self.members[actor].orders then
+--		print("[PARTY] error trying to order, not controlable: ", actor.uid, actor.name)
+		return false
+	end
+	if actor.dead or (game.level and not game.level:hasEntity(actor)) then
+		if vocal then game.logPlayer(game.player, "Can not give orders to this creature.") end
+		return false
+	end
+	if actor.on_can_order and not actor:on_can_order(vocal) then return false end
+	if order and not self.members[actor].orders[order] then
+--		print("[PARTY] error trying to order, unknown order: ", actor.uid, actor.name)
+		return false
+	end
+	return true
+end
+
+function _M:giveOrders(actor)
+	if type(actor) == "number" then actor = self.m_list[actor] end
+
+	local ok, err = self:canOrder(actor, nil, true)
+	if not ok then return nil, err end
+
+	local def = self.members[actor]
+
+	game:registerDialog(PartyOrder.new(actor, def))
+
+	return true
+end
+
+function _M:giveOrder(actor, order)
+	if type(actor) == "number" then actor = self.m_list[actor] end
+
+	local ok, err = self:canOrder(actor, order, true)
+	if not ok then return nil, err end
+
+	local def = self.members[actor]
+
+	if order == "leash" then
+	elseif order == "behavior" then
+--		game:registerDialog(require
+	end
+
+	return true
+end
+
+function _M:select(actor)
+	if not actor then return false end
+	if type(actor) == "number" then actor = self.m_list[actor] end
+	if actor == game.player then return false end
+
+	if self:canControl(actor) then return self:setPlayer(actor)
+	elseif self:canOrder(actor) then return self:giveOrders(actor)
+	end
+	return false
+end

@@ -120,7 +120,7 @@ function _M:makePortrait(a, current, x, y)
 
 	self:mouseTooltip("#GOLD##{bold}#"..a.name.."\n#WHITE##{normal}#Level: "..a.level.."\n"..def.title, 36, 36, x, y, function()
 		if def.control == "full" then
-			game.party:setPlayer(a)
+			game.party:select(a)
 		end
 	end)
 

@@ -133,7 +133,10 @@ newTalent{
 	action = function(self, t)
 		if not self.alchemy_golem then
 			self.alchemy_golem = game.zone:finishEntity(game.level, "actor", makeGolem())
-			game.party:addMember(self.alchemy_golem, {control="full", type="golem", title="Golem"})
+			game.party:addMember(self.alchemy_golem, {
+				control="full", type="golem", title="Golem",
+				orders = {leash=true, behavior=true},
+			})
 			if not self.alchemy_golem then return end
 			self.alchemy_golem.faction = self.faction
 			self.alchemy_golem.name = "golem (servant of "..self.name..")"

@@ -43,15 +43,14 @@ function _M:use(item)
 	if not item then return end
 	game:unregisterDialog(self)
 
-	game.party:setPlayer(item.actor)
+	game.party:select(item.actor)
 end
 
 function _M:generateList()
 	local list = {}
 
 	for i, act in ipairs(game.party.m_list) do
-		local def = game.party.members[act]
-		if def.control == "full" and not act.dead then
+		if game.party:canControl(act) or game.party:canOrder(act) then
 			list[#list+1] = {name=act.name, actor=act}
 		end
 	end

+--- T-Engine display API
+
+module "core.display"
+
+--	{"setTextBlended", set_text_aa},
+--- Set the anti-aliasing status of fonts.
+-- @param status Enable anti-aliasing if true.
+function setTextBlended (status)
+
+--	{"getTextBlended", get_text_aa},
+--- Get the anti-aliasing status of fonts.
+function getTextBlended ()
+
+--	{"forceRedraw", sdl_redraw_screen},
+--- Forces redrawing of the T-Engine display.
+function forceRedraw ()
+
+--	{"fullscreen", sdl_fullscreen},
+--- Toggle fullscreen mode.
+function fullscreen ()
+
+--	{"size", sdl_screen_size},
+--- Set the fullscreen dimensions.
+-- @param width Width in pixels.
+-- @param height Height in pixels.
+function size (width, height)
+
+--	{"newFont", sdl_new_font},
+--- Load a TrueType font.
+-- @param path Font file path relative to the module directory.
+-- @param size The font size.
+-- @return The font userdata.
+function newFont (path, size)
+
+--	{"newSurface", sdl_new_surface},
+--- Create a new SDL surface.
+-- @param width Surface width in pixels.
+-- @param height Surface height in pixels.
+-- @return An SDL surface userdata.
+function newSurface ()
+
+--	{"newTile", sdl_new_tile},
+--- Create a new SDL surface based on a tile.
+-- @param width Surface width in pixels.
+-- @param height Surface height in pixels.
+-- @param font A TrueType font userdata.
+-- @param char An ASCII character to display in the tile.
+-- @param x Horizontal offset to draw the character on the tile (in pixels).
+-- @param y Vertical offset to draw the character on the tile (in pixels).
+-- @param fr Foreground red color (0-255).
+-- @param fg Foreground green color (0-255).
+-- @param fb Foreground blue color (0-255).
+-- @param br Background red color (0-255).
+-- @param bg Background green color (0-255).
+-- @param bb Background blue color (0-255).
+-- @param alpha Alpha factor (0-1).
+-- @return An SDL surface userdata.
+function newTile (width, height, font, char, x, y, fr, fg, fb, br, bg, bb, alpha)
+
+--	{"newFBO", gl_new_fbo},
+--- Creates a new frame buffer object (FBO).
+-- @param width Width of the FBO (in pixels).
+-- @param height Height of the FBO (in pixels).
+-- @return The FBO userdata.
+function newFBO (width, height)
+
+--	{"drawQuad", gl_draw_quad},
+--- Draw a rectangle.
+-- @param x Horizontal offset to start the rectangle (in pixels).
+-- @param y Vertical offset to start the rectangle (in pixels).
+-- @param w Width in pixels.
+-- @param h Height in pixels.
+-- @param r Red color (0-255).
+-- @param g Green color (0-255).
+-- @param b Blue color (0-255).
+-- @param a Alpha factor (0-1).
+-- @param txt Optional OpenGL texture userdata.
+function drawQuad (x, y, w, h, r, g, b, a, txt)
+
+--	{"FBOActive", gl_fbo_is_active},
+--- Check if Frame Buffer Objects are active.
+-- @return Boolean, true if FBOs are active.
+function FBOActive ()
+
+--	{"disableFBO", gl_fbo_disable},
+--- Disable Frame Buffer Objects.
+function disableFBO ()
+
+--	{"drawStringNewSurface", sdl_surface_drawstring_newsurface},
+--- Create a SDL surface of a string.
+-- @param font TrueType font userdata.
+-- @param string String to put on the surface.
+-- @param r Red color of the font (0-255).
+-- @param g Green color of the font (0-255).
+-- @param b Blue color of the font (0-255).
+-- @return An SDL surface userdata.
+function drawStringNewSurface (font, string, r, g, b)
+
+--	{"drawStringBlendedNewSurface", sdl_surface_drawstring_newsurface_aa},
+--- Creates a SDL surface of an anti-aliased string, if possible.
+-- @param font TrueType font userdata.
+-- @param string String to put on the surface.
+-- @param r Red color of the font (0-255).
+-- @param g Green color of the font (0-255).
+-- @param b Blue color of the font (0-255).
+-- @return An SDL surface userdata.
+function drawStringBlendedNewSurface (font, string, r, g, b)
+
+--	{"loadImage", sdl_load_image},
+--- Creates a SDL surface from an image.
+-- @param path Image path relative to the module directory.
+-- @return An SDL surface.
+function loadImage (path)
+
+--	{"setWindowTitle", sdl_set_window_title},
+--- Set the window's title.
+-- @param title The string to use as a title.
+function setWindowTitle (title)
+
+--	{"setWindowSize", sdl_set_window_size},
+--- Set the window dimensions.
+-- @param width Width in pixels.
+-- @param height Height in pixels.
+function setWindowSize (width, height)
+
+--	{"getModesList", sdl_get_modes_list},
+--- Find potential window sizes.
+-- @return A table of tables containing {w=width, h=height}.
+function getModesList ()
+
+--	{"setMouseCursor", sdl_set_mouse_cursor},
+--- Set images for the mouse cursor.
+-- @param ox Horizontal offset (in pixels) of the surface relative to the cursor position.
+-- @param ox Veritcal offset (in pixels) of the surface relative to the cursor position.
+-- @param surface_up SDL surface to use when the mouse button is up.
+-- @param surface_down SDL surface to use when the mouse button is down.
+function setMouseCursor (ox, oy, surface_up, surface_down)
\ No newline at end of file

+--- T-Engine game API
+
+module "core.game"
+
+--	{"reboot", lua_reboot_lua},
+--- Reboot the Lua environment.
+function reboot ()
+	
+--	{"set_current_game", lua_set_current_game},
+--- Sets the current game.
+-- This allows the Lua code to be notified to tick, display and handle quitting.
+-- @param game The Lua game object.
+function set_current_game (game)
+
+--	{"exit_engine", lua_exit_engine},
+--- Tell the C core to quit.
+function exit_engine ()
+
+--	{"getTime", lua_get_time},
+--- Returns the SDL time.
+-- @return The SDL time.
+function getTime ()
+
+--	{"sleep", lua_sleep},
+--- Put the engine to sleep.
+-- @param ms The number of milliseconds to sleep for.
+function sleep (ms)
+
+--	{"setRealtime", lua_set_realtime},
+--- Set the game's frames-per-second rate.
+-- @param fps The frames-per-second.
+function setRealTime (fps)
+
+--	{"setFPS", lua_set_fps},
+--- Set the display's frames-per-second rate.
+-- @param fps The frames-per-second.
+function setFPS (fps)
\ No newline at end of file

+--- T-Engine key API
+module "core.key"
+
+--	{"set_current_handler", lua_set_current_keyhandler},
+--- Sets the Lua keyboard handler.
+-- The keyboard events are then collected by the C core and passed to handler.
+-- @param handler The Lua handler object.
+function set_current_handler (handler)
+
+--	{"modState", lua_get_mod_state},
+--- Check if a modifier key is being pressed.
+-- @param mod The modifier to check for: "ctrl", "shift", "alt" or "meta".
+-- @return A boolean telling whether the modifier is pressed (true) or not (false).
+function modState (mod)
\ No newline at end of file

+--- T-Engine mouse API
+
+module "core.mouse
+--	{"get", lua_get_mouse},
+--- Finds the position of the mouse cursor.
+-- @return The x, y position (in pixels???) of the mouse cursor.
+function get ()
+
+--	{"set", lua_set_mouse},
+--- Moves the mouse cursor.
+-- @param x The x-pixel-coordinate to move the mouse to.
+-- @param y The y-pixel-coordinate to move the mouse to.
+function set (x, y)
+
+--	{"set_current_handler", lua_set_current_mousehandler},
+--- Sets the Lua mouse handler.
+-- The mouse events are then collected by the C core and passed to handler.
+-- @param handler The Lua handler object.
+function set_current_handler (handler)
\ No newline at end of file

+--- T-Engine random number generator API
+-- Uses the SIMD oriented Fast Mersenne Twister.
+
+module "rng"
+--	{"float", rng_float},
+--- Select a random floating point number from a uniform distribution.
+-- @param min The lower limit of the distribution.
+-- @param max The upper limit of the distribution.
+-- @return The randomly selected number.
+function float (min, max)
+
+--	{"__call", rng_call},
+-- GOING TO LEAVE THIS ONE OUT
+-- @param arg1 The upper limit if no arg2, otherwise the lower limit.
+-- @param arg2 The upper limit, or nothing.
+-- @return 
+function __call (arg1, arg2)
+
+--	{"range", rng_range},
+--- Select a random integer from a uniform distribution.
+-- @param min The lower limit of the distribution.
+-- @param max The upper limit of the distribution.
+-- @return The randomly selected integer.
+function range (min, max)
+
+--	{"avg", rng_avg},
+--- The average of several repeated calls to the range function.
+-- @param min The lower limit of the distribution.
+-- @param max The upper limir of the distribution.
+-- @param size The number of samples (default 2).
+-- @return The average from size samples.
+-- @see range
+function avg (min, max, size)
+
+--	{"dice", rng_dice},
+--- The sum of a series of dice rolls.
+-- @param rolls The number of rolls of dice to simulate. (3 in 3d6)
+-- @param sides How many sides the dice has. (6 in 3d6)
+-- @return The sum of the dice rolls.
+function dice (rolls, sides)
+
+--	{"seed", rng_seed},
+--- Set the seed for the random number generator.
+-- The RNG will be re-initialized after setting the seed.
+-- @param new_seed The new seed, unless the number is negative in which case the clock time will be used.
+function seed (new_seed)
+
+--	{"chance", rng_chance},
+--- Decide if a one in X chance occurs.
+-- @param odds The X in "1 in X".  As the X increases, the odds of success decrease accordingly, with a 100/X% chance of returning true.
+-- @return A boolean representing success.
+function chance (odds)
+
+--	{"percent", rng_percent},
+--- Decide if something should occur based on a percent chance.
+-- @param success The percent chance (0-100) to return true.
+-- @return A boolean representing success.
+function percent (success)
+
+--	{"normal", rng_normal},
+--- Select an integer from a normal distribution.
+-- @param mean The mean of the normal distribution
+-- @param stdev The standard deviation of the normal distribution.
+-- @return The selected integer.
+-- @see normalFloat
+function normal (mean, stdev)
+
+--	{"normalFloat", rng_normal_float},
+--- Select a floating point number from a normal distribution.
+-- Uses the Box-Muller transform.
+-- @param mean The mean of the normal distribution
+-- @param stdev The standard deviation of the normal distribution.
+-- @return The selected floating point number.
+-- @see normal
+function normalFloat (mean, stdev)

 #!/bin/sh
 rm -rf doc
 cd game/engines/default/
-luadoc --nofiles -d ../../../doc `find engine -name '*lua'`
+ luadoc --nofiles -d ../../../doc `find ../../../src/ -name 'core*luadoc'` `find engine -name '*lua'`
 cd -
-