forked from bartvdbraak/blender
BGE doc updates:
Fixed some typos and added docs for the following functions: startGame() endGame() restartGame() LibLoad() LibNew() LibFree()
This commit is contained in:
parent
7ba821cab3
commit
952821dfd4
@ -158,6 +158,48 @@ General functions
|
||||
|
||||
Saves bge.logic.globalDict to a file.
|
||||
|
||||
.. function:: startGame(blend)
|
||||
|
||||
Loads the blend file.
|
||||
|
||||
:arg blend: The name of the blend file
|
||||
:type blend: string
|
||||
|
||||
.. function:: endGame()
|
||||
|
||||
Ends the current game.
|
||||
|
||||
.. function:: restartGame()
|
||||
|
||||
Restarts the current game by reloading the .blend file (the last saved version, not what is currently running).
|
||||
|
||||
.. function:: LibLoad(blend, type)
|
||||
|
||||
Converts the all of the datablocks of the given type from the given blend.
|
||||
|
||||
:arg blend: The path to the blend file
|
||||
:type blend: string
|
||||
:arg type: The datablock type (currently only "Scene" and "Mesh" are supported)
|
||||
:type type: string
|
||||
|
||||
.. function:: LibNew(name, type, data)
|
||||
|
||||
Uses existing datablock data and loads in as a new library.
|
||||
|
||||
:arg name: A unique library name used for removal later
|
||||
:type name: string
|
||||
:arg type: The datablock type (currently only "Mesh" is supported)
|
||||
:type type: string
|
||||
:arg data: A list of names of the datablocks to load
|
||||
:type data: list of strings
|
||||
|
||||
.. function:: LibFree(name)
|
||||
|
||||
Frees a library, removing all objects and meshes from the currently active scenes.
|
||||
|
||||
:arg name: The name of the library to free (the name used in LibNew)
|
||||
:type name: string
|
||||
|
||||
.. function:: addScene(name, overlay=1)
|
||||
|
||||
Loads a scene into the game engine.
|
||||
@ -202,24 +244,24 @@ General functions
|
||||
|
||||
.. function:: getMaxLogicFrame()
|
||||
|
||||
Gets the maximum number of logic frame per render frame.
|
||||
Gets the maximum number of logic frames per render frame.
|
||||
|
||||
:return: The maximum number of logic frame per render frame
|
||||
:return: The maximum number of logic frames per render frame
|
||||
:rtype: integer
|
||||
|
||||
.. function:: setMaxLogicFrame(maxlogic)
|
||||
|
||||
Sets the maximum number of logic frame that are executed per render frame.
|
||||
Sets the maximum number of logic frames that are executed per render frame.
|
||||
This does not affect the physic system that still runs at full frame rate.
|
||||
|
||||
:arg maxlogic: The new maximum number of logic frame per render frame. Valid values: 1..5
|
||||
:arg maxlogic: The new maximum number of logic frames per render frame. Valid values: 1..5
|
||||
:type maxlogic: integer
|
||||
|
||||
.. function:: getMaxPhysicsFrame()
|
||||
|
||||
Gets the maximum number of physics frame per render frame.
|
||||
Gets the maximum number of physics frames per render frame.
|
||||
|
||||
:return: The maximum number of physics frame per render frame
|
||||
:return: The maximum number of physics frames per render frame
|
||||
:rtype: integer
|
||||
|
||||
.. function:: setMaxPhysicsFrame(maxphysics)
|
||||
@ -270,14 +312,6 @@ General functions
|
||||
|
||||
.. warning: Not implimented yet
|
||||
|
||||
.. function:: saveGlobalDict()
|
||||
|
||||
Saves bge.logic.globalDict to a file.
|
||||
|
||||
.. function:: loadGlobalDict()
|
||||
|
||||
Loads bge.logic.globalDict from a file.
|
||||
|
||||
*****************
|
||||
Utility functions
|
||||
*****************
|
||||
|
@ -230,7 +230,7 @@ Functions
|
||||
|
||||
.. function:: enableMotionBlur(factor)
|
||||
|
||||
Enable the motion blue effect.
|
||||
Enable the motion blur effect.
|
||||
|
||||
:arg factor: the ammount of motion blur to display.
|
||||
:type factor: float [0.0 - 1.0]
|
||||
@ -238,5 +238,5 @@ Functions
|
||||
|
||||
.. function:: disableMotionBlur()
|
||||
|
||||
Disable the motion blue effect.
|
||||
Disable the motion blur effect.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user