UPBGE 0.3 + Blender 3.1.0 Alpha Python API
68cc97293f07
Documentation
Quickstart: New to Blender or scripting and want to get your feet wet?
API Overview: A more complete explanation of Python integration
API Reference Usage: examples of how to use the API reference docs
Best Practice: Conventions to follow for writing good scripts
Tips and Tricks: Hints to help you while writing scripts for Blender
Gotcha's: Some of the problems you may encounter when writing scripts
Change Log: List of changes since last Blender release
Application Modules
Context Access (bpy.context)
Data Access (bpy.data)
Message Bus (bpy.msgbus)
Operators (bpy.ops)
Types (bpy.types)
Utilities (bpy.utils)
Path Utilities (bpy.path)
Application Data (bpy.app)
Property Definitions (bpy.props)
Game Engine Modules
Game Types (bge.types)
Game Logic (bge.logic)
Rasterizer (bge.render)
Video Texture (bge.texture)
FFmpeg Video and Image Status
Image Blending Modes
Game Keys (bge.events)
Physics Constraints (bge.constraints)
Application Data (bge.app)
Standalone Modules
Audio System (aud)
OpenGL Wrapper (bgl)
Additional Math Functions (bl_math)
Font Drawing (blf)
BMesh Module (bmesh)
Extra Utilities (bpy_extras)
Freestyle Module (freestyle)
GPU Module (gpu)
GPU Utilities (gpu_extras)
ID Property Access (idprop.types)
Image Buffer (imbuf)
Math Types & Utilities (mathutils)
UPBGE 0.3 + Blender 3.1.0 Alpha Python API
»
Index
Index – K
k1 (bpy.types.MovieTrackingCamera attribute)
k2 (bpy.types.MovieTrackingCamera attribute)
k3 (bpy.types.MovieTrackingCamera attribute)
kahr (bpy.types.GameSoftBodySettings attribute)
kchr (bpy.types.GameSoftBodySettings attribute)
kdg (bpy.types.GameSoftBodySettings attribute)
kdp (bpy.types.GameSoftBodySettings attribute)
KDTree (class in mathutils.kdtree)
keep (aud.Handle attribute)
keep_axis (bpy.types.StretchToConstraint attribute)
keep_custom_normals (bpy.types.TriangulateModifier attribute)
keep_sharp (bpy.types.WeightedNormalModifier attribute)
kerning (bpy.types.TextCharacterFormat attribute)
key (bge.types.SCA_KeyboardSensor attribute)
(bpy.types.CompositorNodeTonemap attribute)
(bpy.types.KeyboardSensor attribute)
(bpy.types.SequencerTonemapModifierData attribute)
Key (class in bpy.types)
Key.animation_data (in module bpy.types)
Key.key_blocks (in module bpy.types)
Key.reference_key (in module bpy.types)
Key.user (in module bpy.types)
key_modifier (bpy.types.KeyMapItem attribute)
keyboard (in module bge.logic)
KeyboardSensor (class in bpy.types)
KeyConfig (class in bpy.types)
KeyConfig.is_user_defined (in module bpy.types)
KeyConfig.keymaps (in module bpy.types)
KeyConfig.preferences (in module bpy.types)
keyconfig_activate() (in module bpy.ops.preferences)
keyconfig_export() (in module bpy.ops.preferences)
keyconfig_import() (in module bpy.ops.preferences)
keyconfig_init() (in module bpy.utils)
keyconfig_preset_add() (in module bpy.ops.wm)
keyconfig_remove() (in module bpy.ops.preferences)
keyconfig_set() (in module bpy.utils)
keyconfig_test() (in module bpy.ops.preferences)
(in module bpy_extras.keyconfig_utils)
KeyConfigPreferences (class in bpy.types)
KeyConfigurations (class in bpy.types)
KeyConfigurations.addon (in module bpy.types)
KeyConfigurations.default (in module bpy.types)
KeyConfigurations.user (in module bpy.types)
keyed_loops (bpy.types.ParticleSettings attribute)
keyframe (bpy.types.ThemeDopeSheet attribute)
(bpy.types.ThemeSequenceEditor attribute)
Keyframe (class in bpy.types)
keyframe_a (bpy.types.MovieTrackingObject attribute)
keyframe_b (bpy.types.MovieTrackingObject attribute)
keyframe_border (bpy.types.ThemeDopeSheet attribute)
(bpy.types.ThemeNLAEditor attribute)
keyframe_border_selected (bpy.types.ThemeDopeSheet attribute)
(bpy.types.ThemeNLAEditor attribute)
keyframe_breakdown (bpy.types.ThemeDopeSheet attribute)
keyframe_breakdown_selected (bpy.types.ThemeDopeSheet attribute)
keyframe_clear_button() (in module bpy.ops.anim)
keyframe_clear_v3d() (in module bpy.ops.anim)
keyframe_delete() (bpy.types.bpy_struct method)
(in module bpy.ops.anim)
(in module bpy.ops.clip)
keyframe_delete_button() (in module bpy.ops.anim)
keyframe_delete_by_name() (in module bpy.ops.anim)
keyframe_delete_v3d() (in module bpy.ops.anim)
keyframe_extreme (bpy.types.ThemeDopeSheet attribute)
keyframe_extreme_selected (bpy.types.ThemeDopeSheet attribute)
keyframe_insert() (bpy.types.bpy_struct method)
(in module bpy.ops.action)
(in module bpy.ops.anim)
(in module bpy.ops.clip)
(in module bpy.ops.graph)
keyframe_insert_button() (in module bpy.ops.anim)
keyframe_insert_by_name() (in module bpy.ops.anim)
keyframe_insert_menu() (in module bpy.ops.anim)
keyframe_jitter (bpy.types.ThemeDopeSheet attribute)
keyframe_jitter_selected (bpy.types.ThemeDopeSheet attribute)
keyframe_jump() (in module bpy.ops.screen)
keyframe_movehold (bpy.types.ThemeDopeSheet attribute)
keyframe_movehold_selected (bpy.types.ThemeDopeSheet attribute)
keyframe_new_handle_type (bpy.types.PreferencesEdit attribute)
keyframe_new_interpolation_type (bpy.types.PreferencesEdit attribute)
keyframe_scale_factor (bpy.types.ThemeDopeSheet attribute)
keyframe_selected (bpy.types.ThemeDopeSheet attribute)
keyframe_type (bpy.types.GPencilFrame attribute)
(bpy.types.ToolSettings attribute)
keyframe_type() (in module bpy.ops.action)
keying (bge.texture.DeckLink attribute)
keying_set_active_set() (in module bpy.ops.anim)
keying_set_add() (in module bpy.ops.anim)
keying_set_export() (in module bpy.ops.anim)
keying_set_path_add() (in module bpy.ops.anim)
keying_set_path_remove() (in module bpy.ops.anim)
keying_set_remove() (in module bpy.ops.anim)
KeyingSet (class in bpy.types)
KeyingSet.is_path_absolute (in module bpy.types)
KeyingSet.paths (in module bpy.types)
KeyingSet.type_info (in module bpy.types)
keyingset_add_selected() (in module bpy.ops.outliner)
keyingset_button_add() (in module bpy.ops.anim)
keyingset_button_remove() (in module bpy.ops.anim)
keyingset_remove_selected() (in module bpy.ops.outliner)
KeyingSetInfo (class in bpy.types)
KeyingSetPath (class in bpy.types)
KeyingSetPaths (class in bpy.types)
KeyingSets (class in bpy.types)
KeyingSetsAll (class in bpy.types)
keyitem_add() (in module bpy.ops.preferences)
keyitem_remove() (in module bpy.ops.preferences)
keyitem_restore() (in module bpy.ops.preferences)
KeyMap (class in bpy.types)
KeyMap.is_modal (in module bpy.types)
KeyMap.keymap_items (in module bpy.types)
KeyMap.name (in module bpy.types)
KeyMap.region_type (in module bpy.types)
KeyMap.space_type (in module bpy.types)
keymap_restore() (in module bpy.ops.preferences)
KeyMapItem (class in bpy.types)
KeyMapItem.id (in module bpy.types)
KeyMapItem.is_user_defined (in module bpy.types)
KeyMapItem.is_user_modified (in module bpy.types)
KeyMapItem.name (in module bpy.types)
KeyMapItem.properties (in module bpy.types)
KeyMapItems (class in bpy.types)
KeyMaps (class in bpy.types)
keys() (bmesh.types.BMDeformVert method)
(bmesh.types.BMLayerCollection method)
(bpy.types.bpy_prop_collection method)
(bpy.types.bpy_struct method)
(idprop.types.IDPropertyGroup method)
keys_step (bpy.types.ParticleSettings attribute)
kinematic (bpy.types.RigidBodyObject attribute)
KinematicConstraint (class in bpy.types)
kink (bpy.types.ParticleSettings attribute)
kink_amp_factor (bpy.types.ParticleSettingsTextureSlot attribute)
kink_amplitude (bpy.types.ParticleSettings attribute)
kink_amplitude_clump (bpy.types.ParticleSettings attribute)
kink_amplitude_random (bpy.types.ParticleSettings attribute)
kink_axis (bpy.types.ParticleSettings attribute)
kink_axis_random (bpy.types.ParticleSettings attribute)
kink_extra_steps (bpy.types.ParticleSettings attribute)
kink_flat (bpy.types.ParticleSettings attribute)
kink_freq_factor (bpy.types.ParticleSettingsTextureSlot attribute)
kink_frequency (bpy.types.ParticleSettings attribute)
kink_shape (bpy.types.ParticleSettings attribute)
KKEY (in module bge.events)
kkhr (bpy.types.GameSoftBodySettings attribute)
klf (bpy.types.GameSoftBodySettings attribute)
knife_project() (in module bpy.ops.mesh)
knife_tool() (in module bpy.ops.mesh)
kpr (bpy.types.GameSoftBodySettings attribute)
kr_derivative_epsilon (bpy.types.FreestyleSettings attribute)
kshr (bpy.types.GameSoftBodySettings attribute)
ksk_split_cl (bpy.types.GameSoftBodySettings attribute)
kskhr_cl (bpy.types.GameSoftBodySettings attribute)
ksr_split_cl (bpy.types.GameSoftBodySettings attribute)
ksrhr_cl (bpy.types.GameSoftBodySettings attribute)
kss_split_cl (bpy.types.GameSoftBodySettings attribute)
ksshr_cl (bpy.types.GameSoftBodySettings attribute)
kvc (bpy.types.GameSoftBodySettings attribute)
kvcf (bpy.types.GameSoftBodySettings attribute)
KX_2DFilter (class in bge.types)
KX_2DFilterFrameBuffer (class in bge.types)
KX_2DFilterManager (class in bge.types)
KX_ACT_ARMATURE_DISABLE (in module bge.logic)
KX_ACT_ARMATURE_ENABLE (in module bge.logic)
KX_ACT_ARMATURE_RUN (in module bge.logic)
KX_ACT_ARMATURE_SETINFLUENCE (in module bge.logic)
KX_ACT_ARMATURE_SETTARGET (in module bge.logic)
KX_ACT_ARMATURE_SETWEIGHT (in module bge.logic)
KX_ACT_MOUSE_OBJECT_AXIS_X (in module bge.logic)
KX_ACT_MOUSE_OBJECT_AXIS_Y (in module bge.logic)
KX_ACT_MOUSE_OBJECT_AXIS_Z (in module bge.logic)
KX_ACTION_BLEND_ADD (in module bge.logic)
KX_ACTION_BLEND_BLEND (in module bge.logic)
KX_ACTION_MODE_LOOP (in module bge.logic)
KX_ACTION_MODE_PING_PONG (in module bge.logic)
KX_ACTION_MODE_PLAY (in module bge.logic)
KX_ACTIONACT_FLIPPER (in module bge.logic)
KX_ACTIONACT_LOOPEND (in module bge.logic)
KX_ACTIONACT_LOOPSTOP (in module bge.logic)
KX_ACTIONACT_PINGPONG (in module bge.logic)
KX_ACTIONACT_PLAY (in module bge.logic)
KX_ACTIONACT_PROPERTY (in module bge.logic)
KX_ARMSENSOR_LIN_ERROR_ABOVE (in module bge.logic)
KX_ARMSENSOR_LIN_ERROR_BELOW (in module bge.logic)
KX_ARMSENSOR_ROT_ERROR_ABOVE (in module bge.logic)
KX_ARMSENSOR_ROT_ERROR_BELOW (in module bge.logic)
KX_ARMSENSOR_STATE_CHANGED (in module bge.logic)
KX_BLENDER_GLSL_MATERIAL (in module bge.render)
KX_BLENDER_MULTITEX_MATERIAL (in module bge.render)
KX_BlenderMaterial (class in bge.types)
KX_Camera (class in bge.types)
KX_Camera.INSIDE (in module bge.types)
KX_Camera.INTERSECT (in module bge.types)
KX_Camera.OUTSIDE (in module bge.types)
KX_CharacterWrapper (class in bge.types)
KX_CollisionContactPoint (class in bge.types)
KX_CONSTRAINTACT_DIRNX (in module bge.logic)
KX_CONSTRAINTACT_DIRNY (in module bge.logic)
KX_CONSTRAINTACT_DIRNZ (in module bge.logic)
KX_CONSTRAINTACT_DIRPX (in module bge.logic)
KX_CONSTRAINTACT_DIRPY (in module bge.logic)
KX_CONSTRAINTACT_DIRPZ (in module bge.logic)
KX_CONSTRAINTACT_DISTANCE (in module bge.logic)
KX_CONSTRAINTACT_DOROTFH (in module bge.logic)
KX_CONSTRAINTACT_FHNX (in module bge.logic)
KX_CONSTRAINTACT_FHNY (in module bge.logic)
KX_CONSTRAINTACT_FHNZ (in module bge.logic)
KX_CONSTRAINTACT_FHPX (in module bge.logic)
KX_CONSTRAINTACT_FHPY (in module bge.logic)
KX_CONSTRAINTACT_FHPZ (in module bge.logic)
KX_CONSTRAINTACT_LOCAL (in module bge.logic)
KX_CONSTRAINTACT_LOCX (in module bge.logic)
KX_CONSTRAINTACT_LOCY (in module bge.logic)
KX_CONSTRAINTACT_LOCZ (in module bge.logic)
KX_CONSTRAINTACT_MATERIAL (in module bge.logic)
KX_CONSTRAINTACT_NORMAL (in module bge.logic)
KX_CONSTRAINTACT_ORIX (in module bge.logic)
KX_CONSTRAINTACT_ORIY (in module bge.logic)
KX_CONSTRAINTACT_ORIZ (in module bge.logic)
KX_CONSTRAINTACT_PERMANENT (in module bge.logic)
KX_CONSTRAINTACT_ROTX (in module bge.logic)
KX_CONSTRAINTACT_ROTY (in module bge.logic)
KX_CONSTRAINTACT_ROTZ (in module bge.logic)
KX_ConstraintWrapper (class in bge.types)
KX_DYN_DISABLE_DYNAMICS (in module bge.logic)
KX_DYN_DISABLE_RIGID_BODY (in module bge.logic)
KX_DYN_ENABLE_RIGID_BODY (in module bge.logic)
KX_DYN_RESTORE_DYNAMICS (in module bge.logic)
KX_DYN_SET_MASS (in module bge.logic)
KX_FALSE (in module bge.logic)
KX_FontObject (class in bge.types)
KX_GAME_LOAD (in module bge.logic)
KX_GAME_LOADCFG (in module bge.logic)
KX_GAME_QUIT (in module bge.logic)
KX_GAME_RESTART (in module bge.logic)
KX_GAME_SAVECFG (in module bge.logic)
KX_GAME_START (in module bge.logic)
KX_GameObject (class in bge.types)
KX_INPUT_ACTIVE (in module bge.logic)
KX_INPUT_JUST_ACTIVATED (in module bge.logic)
KX_INPUT_JUST_RELEASED (in module bge.logic)
KX_INPUT_NONE (in module bge.logic)
KX_LibLoadStatus (class in bge.types)
KX_LightObject (class in bge.types)
KX_LodLevel (class in bge.types)
KX_LodManager (class in bge.types)
KX_MeshProxy (class in bge.types)
KX_MOUSE_BUT_BUTTON4 (in module bge.logic)
KX_MOUSE_BUT_BUTTON5 (in module bge.logic)
KX_MOUSE_BUT_BUTTON6 (in module bge.logic)
KX_MOUSE_BUT_BUTTON7 (in module bge.logic)
KX_MOUSE_BUT_LEFT (in module bge.logic)
KX_MOUSE_BUT_MIDDLE (in module bge.logic)
KX_MOUSE_BUT_RIGHT (in module bge.logic)
KX_NavMeshObject (class in bge.types)
KX_PARENT_REMOVE (in module bge.logic)
KX_PARENT_SET (in module bge.logic)
KX_PolyProxy (class in bge.types)
KX_PROPSENSOR_CHANGED (in module bge.logic)
KX_PROPSENSOR_EQUAL (in module bge.logic)
KX_PROPSENSOR_EXPRESSION (in module bge.logic)
KX_PROPSENSOR_GREATERTHAN (in module bge.logic)
KX_PROPSENSOR_INTERVAL (in module bge.logic)
KX_PROPSENSOR_LESSTHAN (in module bge.logic)
KX_PROPSENSOR_NOTEQUAL (in module bge.logic)
KX_PythonComponent (class in bge.types)
KX_RADAR_AXIS_NEG_X (in module bge.logic)
KX_RADAR_AXIS_NEG_Y (in module bge.logic)
KX_RADAR_AXIS_NEG_Z (in module bge.logic)
KX_RADAR_AXIS_POS_X (in module bge.logic)
KX_RADAR_AXIS_POS_Y (in module bge.logic)
KX_RADAR_AXIS_POS_Z (in module bge.logic)
KX_RANDOMACT_BOOL_BERNOUILLI (in module bge.logic)
KX_RANDOMACT_BOOL_CONST (in module bge.logic)
KX_RANDOMACT_BOOL_UNIFORM (in module bge.logic)
KX_RANDOMACT_FLOAT_CONST (in module bge.logic)
KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL (in module bge.logic)
KX_RANDOMACT_FLOAT_NORMAL (in module bge.logic)
KX_RANDOMACT_FLOAT_UNIFORM (in module bge.logic)
KX_RANDOMACT_INT_CONST (in module bge.logic)
KX_RANDOMACT_INT_POISSON (in module bge.logic)
KX_RANDOMACT_INT_UNIFORM (in module bge.logic)
KX_RAY_AXIS_NEG_X (in module bge.logic)
KX_RAY_AXIS_NEG_Y (in module bge.logic)
KX_RAY_AXIS_NEG_Z (in module bge.logic)
KX_RAY_AXIS_POS_X (in module bge.logic)
KX_RAY_AXIS_POS_Y (in module bge.logic)
KX_RAY_AXIS_POS_Z (in module bge.logic)
KX_Scene (class in bge.types)
KX_SCENE_ADD_BACK_SCENE (in module bge.logic)
KX_SCENE_ADD_FRONT_SCENE (in module bge.logic)
KX_SCENE_REMOVE_SCENE (in module bge.logic)
KX_SCENE_RESTART (in module bge.logic)
KX_SCENE_RESUME (in module bge.logic)
KX_SCENE_SET_CAMERA (in module bge.logic)
KX_SCENE_SET_SCENE (in module bge.logic)
KX_SCENE_SUSPEND (in module bge.logic)
KX_SENSOR_ACTIVE (in module bge.logic)
KX_SENSOR_INACTIVE (in module bge.logic)
KX_SENSOR_JUST_ACTIVATED (in module bge.logic)
KX_SENSOR_JUST_DEACTIVATED (in module bge.logic)
KX_SOUNDACT_LOOPBIDIRECTIONAL (in module bge.logic)
KX_SOUNDACT_LOOPBIDIRECTIONAL_STOP (in module bge.logic)
KX_SOUNDACT_LOOPEND (in module bge.logic)
KX_SOUNDACT_LOOPSTOP (in module bge.logic)
KX_SOUNDACT_PLAYEND (in module bge.logic)
KX_SOUNDACT_PLAYSTOP (in module bge.logic)
KX_STATE1 (in module bge.logic)
KX_STATE10 (in module bge.logic)
KX_STATE11 (in module bge.logic)
KX_STATE12 (in module bge.logic)
KX_STATE13 (in module bge.logic)
KX_STATE14 (in module bge.logic)
KX_STATE15 (in module bge.logic)
KX_STATE16 (in module bge.logic)
KX_STATE17 (in module bge.logic)
KX_STATE18 (in module bge.logic)
KX_STATE19 (in module bge.logic)
KX_STATE2 (in module bge.logic)
KX_STATE20 (in module bge.logic)
KX_STATE21 (in module bge.logic)
KX_STATE22 (in module bge.logic)
KX_STATE23 (in module bge.logic)
KX_STATE24 (in module bge.logic)
KX_STATE25 (in module bge.logic)
KX_STATE26 (in module bge.logic)
KX_STATE27 (in module bge.logic)
KX_STATE28 (in module bge.logic)
KX_STATE29 (in module bge.logic)
KX_STATE3 (in module bge.logic)
KX_STATE30 (in module bge.logic)
KX_STATE4 (in module bge.logic)
KX_STATE5 (in module bge.logic)
KX_STATE6 (in module bge.logic)
KX_STATE7 (in module bge.logic)
KX_STATE8 (in module bge.logic)
KX_STATE9 (in module bge.logic)
KX_STATE_OP_CLR (in module bge.logic)
KX_STATE_OP_CPY (in module bge.logic)
KX_STATE_OP_NEG (in module bge.logic)
KX_STATE_OP_SET (in module bge.logic)
KX_STEERING_FLEE (in module bge.logic)
KX_STEERING_PATHFOLLOWING (in module bge.logic)
KX_STEERING_SEEK (in module bge.logic)
KX_TEXFACE_MATERIAL (in module bge.render)
KX_TRACK_TRAXIS_NEG_X (in module bge.logic)
KX_TRACK_TRAXIS_NEG_Y (in module bge.logic)
KX_TRACK_TRAXIS_NEG_Z (in module bge.logic)
KX_TRACK_TRAXIS_POS_X (in module bge.logic)
KX_TRACK_TRAXIS_POS_Y (in module bge.logic)
KX_TRACK_TRAXIS_POS_Z (in module bge.logic)
KX_TRACK_UPAXIS_POS_X (in module bge.logic)
KX_TRACK_UPAXIS_POS_Y (in module bge.logic)
KX_TRACK_UPAXIS_POS_Z (in module bge.logic)
KX_TRUE (in module bge.logic)
KX_VehicleWrapper (class in bge.types)
KX_VertexProxy (class in bge.types)