fake-bge-module 20250312__py3-none-any.whl → 20260203__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {animsys_refactor → _animsys_refactor}/__init__.pyi +7 -6
- {bl_console_utils → _bl_console_utils}/__init__.pyi +1 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/__init__.pyi +1 -0
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_calltip/__init__.pyi +1 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_import/__init__.pyi +1 -5
- {bl_console_utils → _bl_console_utils}/autocomplete/complete_namespace/__init__.pyi +3 -13
- {bl_console_utils → _bl_console_utils}/autocomplete/intellisense/__init__.pyi +1 -10
- {bl_i18n_utils → _bl_i18n_utils}/__init__.pyi +2 -0
- _bl_i18n_utils/bl_extract_messages/__init__.pyi +28 -0
- {bl_i18n_utils → _bl_i18n_utils}/merge_po/__init__.pyi +2 -1
- {bl_i18n_utils → _bl_i18n_utils}/settings/__init__.pyi +10 -7
- {bl_i18n_utils → _bl_i18n_utils}/utils/__init__.pyi +53 -50
- _bl_i18n_utils/utils_cli/__init__.pyi +11 -0
- _bl_i18n_utils/utils_languages_menu/__init__.pyi +6 -0
- {bl_i18n_utils → _bl_i18n_utils}/utils_rtl/__init__.pyi +3 -2
- _bl_i18n_utils/utils_spell_check/__init__.pyi +22 -0
- {bl_previews_utils → _bl_previews_utils}/__init__.pyi +1 -0
- _bl_previews_utils/bl_previews_render/__init__.pyi +14 -0
- {bl_rna_utils → _bl_rna_utils}/__init__.pyi +1 -0
- {bl_rna_utils → _bl_rna_utils}/data_path/__init__.pyi +3 -2
- {bl_text_utils → _bl_text_utils}/__init__.pyi +1 -0
- _bl_text_utils/external_editor/__init__.pyi +6 -0
- {bl_ui_utils → _bl_ui_utils}/__init__.pyi +1 -0
- {bl_ui_utils → _bl_ui_utils}/layout/__init__.pyi +2 -1
- _blendfile_header/__init__.pyi +48 -0
- _bpy_internal/__init__.pyi +5 -1
- _bpy_internal/addons/__init__.pyi +1 -0
- _bpy_internal/addons/cli/__init__.pyi +2 -1
- _bpy_internal/assets/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/__init__.pyi +5 -0
- _bpy_internal/assets/remote_library_listing/blender_asset_library_openapi/__init__.pyi +13 -0
- _bpy_internal/disk_file_hash_service/__init__.pyi +19 -0
- _bpy_internal/disk_file_hash_service/backend_sqlite/__init__.pyi +48 -0
- _bpy_internal/disk_file_hash_service/hash_service/__init__.pyi +64 -0
- _bpy_internal/disk_file_hash_service/types/__init__.pyi +53 -0
- _bpy_internal/extensions/__init__.pyi +1 -0
- _bpy_internal/extensions/junction_module/__init__.pyi +8 -7
- _bpy_internal/extensions/stale_file_manager/__init__.pyi +9 -8
- _bpy_internal/extensions/wheel_manager/__init__.pyi +6 -5
- {bl_i18n_utils/utils_languages_menu → _bpy_internal/filesystem}/__init__.pyi +2 -2
- _bpy_internal/filesystem/locking/__init__.pyi +28 -0
- _bpy_internal/grease_pencil/__init__.pyi +1 -0
- _bpy_internal/grease_pencil/stroke/__init__.pyi +22 -6
- _bpy_internal/platform/__init__.pyi +5 -0
- _bpy_internal/platform/freedesktop/__init__.pyi +21 -0
- _bpy_internal/system_info/__init__.pyi +1 -0
- _bpy_internal/system_info/text_generate_runtime/__init__.pyi +2 -1
- _bpy_internal/system_info/url_prefill_runtime/__init__.pyi +2 -1
- _bpy_internal/system_info/url_prefill_startup/__init__.pyi +3 -2
- {bpy_restrict_state → _bpy_restrict_state}/__init__.pyi +1 -0
- _bpy_types/__init__.pyi +1635 -0
- {console_python → _console_python}/__init__.pyi +8 -7
- _console_shell/__init__.pyi +10 -0
- {graphviz_export → _graphviz_export}/__init__.pyi +3 -2
- _keyingsets_utils/__init__.pyi +21 -0
- {rna_info → _rna_info}/__init__.pyi +32 -27
- {rna_xml → _rna_xml}/__init__.pyi +7 -6
- addon_utils/__init__.pyi +13 -25
- aud/__init__.pyi +133 -155
- bge/__init__.pyi +1 -0
- bge/app/__init__.pyi +1 -0
- bge/constraints/__init__.pyi +22 -51
- bge/types/__init__.pyi +618 -1913
- bge_extras/__init__.pyi +1 -0
- bge_extras/logger/__init__.pyi +4 -3
- bgui/__init__.pyi +1 -0
- bgui/frame/__init__.pyi +1 -0
- bgui/frame_button/__init__.pyi +1 -0
- bgui/image/__init__.pyi +1 -1
- bgui/image_button/__init__.pyi +1 -0
- bgui/label/__init__.pyi +1 -0
- bgui/list_box/__init__.pyi +1 -1
- bgui/progress_bar/__init__.pyi +2 -1
- bgui/system/__init__.pyi +3 -5
- bgui/text_block/__init__.pyi +1 -0
- bgui/text_input/__init__.pyi +9 -8
- bgui/theme/__init__.pyi +4 -3
- bgui/widget/__init__.pyi +5 -4
- bl_app_override/__init__.pyi +4 -3
- bl_app_override/helpers/__init__.pyi +3 -2
- bl_app_template_utils/__init__.pyi +5 -4
- bl_app_templates_system/Game_Engine/__init__.pyi +5 -4
- bl_app_templates_system/Storyboarding/__init__.pyi +11 -0
- bl_app_templates_system/__init__.pyi +2 -0
- bl_keymap_utils/__init__.pyi +1 -0
- bl_keymap_utils/io/__init__.pyi +10 -9
- bl_keymap_utils/keymap_from_toolbar/__init__.pyi +2 -1
- bl_keymap_utils/keymap_hierarchy/__init__.pyi +2 -1
- bl_keymap_utils/platform_helpers/__init__.pyi +3 -2
- bl_keymap_utils/versioning/__init__.pyi +2 -1
- bl_math/__init__.pyi +4 -13
- bl_operators/__init__.pyi +4 -2
- bl_operators/add_mesh_torus/__init__.pyi +9 -9
- bl_operators/anim/__init__.pyi +90 -62
- bl_operators/assets/__init__.pyi +14 -18
- bl_operators/bmesh/__init__.pyi +1 -0
- bl_operators/bmesh/find_adjacent/__init__.pyi +12 -9
- bl_operators/bone_selection_sets/__init__.pyi +34 -60
- bl_operators/clip/__init__.pyi +39 -57
- bl_operators/connect_to_output/__init__.pyi +20 -18
- bl_operators/console/__init__.pyi +17 -25
- bl_operators/constraint/__init__.pyi +15 -21
- bl_operators/copy_global_transform/__init__.pyi +261 -0
- bl_operators/file/__init__.pyi +13 -17
- bl_operators/freestyle/__init__.pyi +15 -21
- bl_operators/geometry_nodes/__init__.pyi +30 -36
- bl_operators/grease_pencil/__init__.pyi +5 -5
- bl_operators/image/__init__.pyi +14 -22
- bl_operators/image_as_planes/__init__.pyi +36 -42
- bl_operators/mesh/__init__.pyi +8 -53
- bl_operators/node/__init__.pyi +375 -92
- bl_operators/node_editor/__init__.pyi +1 -0
- bl_operators/node_editor/node_functions/__init__.pyi +10 -9
- bl_operators/object/__init__.pyi +57 -98
- bl_operators/object_align/__init__.pyi +8 -8
- bl_operators/object_quick_effects/__init__.pyi +15 -21
- bl_operators/object_randomize_transform/__init__.pyi +6 -6
- bl_operators/presets/__init__.pyi +46 -94
- bl_operators/rigidbody/__init__.pyi +12 -16
- bl_operators/screen_play_rendered_anim/__init__.pyi +5 -5
- bl_operators/sequencer/__init__.pyi +40 -54
- bl_operators/spreadsheet/__init__.pyi +7 -7
- bl_operators/userpref/__init__.pyi +69 -117
- bl_operators/uvcalc_follow_active/__init__.pyi +8 -8
- bl_operators/uvcalc_lightmap/__init__.pyi +12 -12
- bl_operators/uvcalc_transform/__init__.pyi +39 -28
- bl_operators/vertexpaint_dirt/__init__.pyi +7 -7
- bl_operators/view3d/__init__.pyi +31 -43
- bl_operators/wm/__init__.pyi +139 -231
- bl_operators/world/__init__.pyi +6 -6
- bl_ui/__init__.pyi +18 -17
- bl_ui/anim/__init__.pyi +5 -5
- bl_ui/asset_shelf/__init__.pyi +5 -5
- bl_ui/generic_ui_list/__init__.pyi +12 -26
- bl_ui/node_add_menu/__init__.pyi +281 -12
- bl_ui/node_add_menu_compositor/__init__.pyi +135 -91
- bl_ui/node_add_menu_geometry/__init__.pyi +407 -263
- bl_ui/node_add_menu_shader/__init__.pyi +67 -67
- bl_ui/node_add_menu_texture/__init__.pyi +25 -69
- bl_ui/properties_animviz/__init__.pyi +3 -2
- bl_ui/properties_collection/__init__.pyi +20 -30
- bl_ui/properties_constraint/__init__.pyi +228 -450
- bl_ui/properties_data_armature/__init__.pyi +45 -79
- bl_ui/properties_data_bone/__init__.pyi +33 -51
- bl_ui/properties_data_camera/__init__.pyi +43 -75
- bl_ui/properties_data_curve/__init__.pyi +42 -101
- bl_ui/properties_data_curves/__init__.pyi +21 -35
- bl_ui/properties_data_empty/__init__.pyi +8 -10
- bl_ui/properties_data_grease_pencil/__init__.pyi +49 -87
- bl_ui/properties_data_lattice/__init__.pyi +12 -18
- bl_ui/properties_data_light/__init__.pyi +28 -46
- bl_ui/properties_data_lightprobe/__init__.pyi +35 -61
- bl_ui/properties_data_mesh/__init__.pyi +73 -120
- bl_ui/properties_data_metaball/__init__.pyi +16 -26
- bl_ui/properties_data_modifier/__init__.pyi +34 -39
- bl_ui/properties_data_pointcloud/__init__.pyi +17 -27
- bl_ui/properties_data_shaderfx/__init__.pyi +4 -4
- bl_ui/properties_data_speaker/__init__.pyi +15 -25
- bl_ui/properties_data_volume/__init__.pyi +22 -38
- bl_ui/properties_freestyle/__init__.pyi +79 -127
- bl_ui/properties_game/__init__.pyi +88 -84
- bl_ui/properties_grease_pencil_common/__init__.pyi +33 -190
- bl_ui/properties_mask_common/__init__.pyi +33 -45
- bl_ui/properties_material/__init__.pyi +52 -111
- bl_ui/properties_material_gpencil/__init__.pyi +48 -68
- bl_ui/properties_object/__init__.pyi +123 -93
- bl_ui/properties_output/__init__.pyi +103 -81
- bl_ui/properties_paint_common/__init__.pyi +78 -59
- bl_ui/properties_particle/__init__.pyi +160 -262
- bl_ui/properties_physics_cloth/__init__.pyi +36 -62
- bl_ui/properties_physics_common/__init__.pyi +11 -11
- bl_ui/properties_physics_dynamicpaint/__init__.pyi +81 -123
- bl_ui/properties_physics_field/__init__.pyi +35 -53
- bl_ui/properties_physics_fluid/__init__.pyi +106 -160
- bl_ui/properties_physics_geometry_nodes/__init__.pyi +6 -6
- bl_ui/properties_physics_rigidbody/__init__.pyi +28 -42
- bl_ui/properties_physics_rigidbody_constraint/__init__.pyi +44 -68
- bl_ui/properties_physics_softbody/__init__.pyi +38 -66
- bl_ui/properties_render/__init__.pyi +267 -259
- bl_ui/properties_scene/__init__.pyi +69 -72
- bl_ui/properties_strip/__init__.pyi +744 -0
- bl_ui/properties_strip_modifier/__init__.pyi +45 -0
- bl_ui/properties_texture/__init__.pyi +69 -122
- bl_ui/properties_view_layer/__init__.pyi +97 -51
- bl_ui/properties_workspace/__init__.pyi +12 -18
- bl_ui/properties_world/__init__.pyi +33 -53
- bl_ui/space_clip/__init__.pyi +231 -311
- bl_ui/space_console/__init__.pyi +14 -24
- bl_ui/space_dopesheet/__init__.pyi +193 -125
- bl_ui/space_filebrowser/__init__.pyi +107 -131
- bl_ui/space_graph/__init__.pyi +93 -80
- bl_ui/space_image/__init__.pyi +207 -291
- bl_ui/space_info/__init__.pyi +14 -24
- bl_ui/space_logic/__init__.pyi +14 -22
- bl_ui/space_nla/__init__.pyi +63 -69
- bl_ui/space_node/__init__.pyi +215 -154
- bl_ui/space_outliner/__init__.pyi +65 -61
- bl_ui/space_properties/__init__.pyi +41 -16
- bl_ui/space_sequencer/__init__.pyi +276 -979
- bl_ui/space_spreadsheet/__init__.pyi +27 -23
- bl_ui/space_statusbar/__init__.pyi +4 -4
- bl_ui/space_text/__init__.pyi +39 -73
- bl_ui/space_time/__init__.pyi +33 -78
- bl_ui/space_toolsystem_common/__init__.pyi +31 -28
- bl_ui/space_toolsystem_toolbar/__init__.pyi +67 -43
- bl_ui/space_topbar/__init__.pyi +68 -111
- bl_ui/space_userpref/__init__.pyi +310 -445
- bl_ui/space_view3d/__init__.pyi +667 -1122
- bl_ui/space_view3d_sidebar/__init__.pyi +127 -0
- bl_ui/space_view3d_toolbar/__init__.pyi +237 -966
- bl_ui/utils/__init__.pyi +4 -3
- blend_render_info/__init__.pyi +4 -2
- blf/__init__.pyi +92 -59
- bmesh/__init__.pyi +4 -10
- bmesh/geometry/__init__.pyi +2 -4
- bmesh/ops/__init__.pyi +442 -815
- bmesh/types/__init__.pyi +377 -720
- bmesh/utils/__init__.pyi +20 -45
- bpy/__init__.pyi +2 -1
- bpy/app/__init__.pyi +96 -90
- bpy/app/handlers/__init__.pyi +24 -19
- bpy/app/icons/__init__.pyi +2 -7
- bpy/app/timers/__init__.pyi +5 -18
- bpy/app/translations/__init__.pyi +21 -35
- bpy/msgbus/__init__.pyi +20 -9
- bpy/ops/__init__.pyi +21 -3
- bpy/ops/action/__init__.pyi +121 -226
- bpy/ops/anim/__init__.pyi +204 -358
- bpy/ops/armature/__init__.pyi +129 -249
- bpy/ops/asset/__init__.pyi +82 -111
- bpy/ops/bge_bricknodes/__init__.pyi +61 -0
- bpy/ops/boid/__init__.pyi +44 -50
- bpy/ops/bricknodes/__init__.pyi +37 -0
- bpy/ops/brush/__init__.pyi +33 -120
- bpy/ops/buttons/__init__.pyi +27 -83
- bpy/ops/cachefile/__init__.pyi +16 -74
- bpy/ops/camera/__init__.pyi +3 -13
- bpy/ops/clip/__init__.pyi +278 -558
- bpy/ops/cloth/__init__.pyi +2 -6
- bpy/ops/collection/__init__.pyi +34 -44
- bpy/ops/console/__init__.pyi +70 -111
- bpy/ops/constraint/__init__.pyi +34 -102
- bpy/ops/curve/__init__.pyi +163 -315
- bpy/ops/curves/__init__.pyi +163 -189
- bpy/ops/cycles/__init__.pyi +8 -18
- bpy/ops/dpaint/__init__.pyi +21 -30
- bpy/ops/ed/__init__.pyi +59 -103
- bpy/ops/export_anim/__init__.pyi +4 -11
- bpy/ops/export_scene/__init__.pyi +29 -174
- bpy/ops/extensions/__init__.pyi +102 -194
- bpy/ops/file/__init__.pyi +166 -272
- bpy/ops/fluid/__init__.pyi +78 -86
- bpy/ops/font/__init__.pyi +73 -164
- bpy/ops/geometry/__init__.pyi +33 -144
- bpy/ops/gizmogroup/__init__.pyi +8 -14
- bpy/ops/gpencil/__init__.pyi +31 -58
- bpy/ops/graph/__init__.pyi +176 -411
- bpy/ops/grease_pencil/__init__.pyi +416 -639
- bpy/ops/image/__init__.pyi +148 -492
- bpy/ops/import_anim/__init__.pyi +5 -18
- bpy/ops/import_curve/__init__.pyi +4 -6
- bpy/ops/import_scene/__init__.pyi +22 -49
- bpy/ops/info/__init__.pyi +27 -43
- bpy/ops/lattice/__init__.pyi +26 -43
- bpy/ops/logic/__init__.pyi +49 -122
- bpy/ops/logic_nodes/__init__.pyi +461 -0
- bpy/ops/marker/__init__.pyi +24 -60
- bpy/ops/mask/__init__.pyi +118 -222
- bpy/ops/material/__init__.pyi +19 -18
- bpy/ops/mball/__init__.pyi +13 -39
- bpy/ops/mesh/__init__.pyi +409 -1264
- bpy/ops/nla/__init__.pyi +140 -232
- bpy/ops/node/__init__.pyi +1189 -807
- bpy/ops/object/__init__.pyi +806 -1659
- bpy/ops/outliner/__init__.pyi +284 -432
- bpy/ops/paint/__init__.pyi +189 -381
- bpy/ops/paintcurve/__init__.pyi +29 -44
- bpy/ops/palette/__init__.pyi +23 -34
- bpy/ops/particle/__init__.pyi +135 -201
- bpy/ops/pointcloud/__init__.pyi +23 -42
- bpy/ops/pose/__init__.pyi +195 -310
- bpy/ops/poselib/__init__.pyi +45 -73
- bpy/ops/preferences/__init__.pyi +89 -221
- bpy/ops/ptcache/__init__.pyi +32 -39
- bpy/ops/render/__init__.pyi +36 -83
- bpy/ops/rigidbody/__init__.pyi +47 -78
- bpy/ops/scene/__init__.pyi +169 -222
- bpy/ops/screen/__init__.pyi +146 -259
- bpy/ops/script/__init__.pyi +9 -15
- bpy/ops/sculpt/__init__.pyi +194 -354
- bpy/ops/sculpt_curves/__init__.pyi +21 -29
- bpy/ops/sequencer/__init__.pyi +586 -836
- bpy/ops/sound/__init__.pyi +25 -131
- bpy/ops/spreadsheet/__init__.pyi +34 -21
- bpy/ops/surface/__init__.pyi +7 -54
- bpy/ops/text/__init__.pyi +166 -281
- bpy/ops/text_editor/__init__.pyi +2 -6
- bpy/ops/texture/__init__.pyi +20 -22
- bpy/ops/transform/__init__.pyi +108 -445
- bpy/ops/ui/__init__.pyi +157 -219
- bpy/ops/uilist/__init__.pyi +4 -16
- bpy/ops/uv/__init__.pyi +291 -347
- bpy/ops/view2d/__init__.pyi +29 -88
- bpy/ops/view3d/__init__.pyi +238 -438
- bpy/ops/wm/__init__.pyi +651 -1510
- bpy/ops/workspace/__init__.pyi +42 -44
- bpy/ops/world/__init__.pyi +12 -13
- bpy/path/__init__.pyi +6 -37
- bpy/props/__init__.pyi +395 -259
- bpy/{_typing → stub_internal}/__init__.pyi +1 -0
- bpy/{_typing → stub_internal}/rna_enums/__init__.pyi +214 -114
- bpy/types/__init__.pyi +93286 -103826
- bpy/utils/__init__.pyi +46 -104
- bpy/utils/previews/__init__.pyi +7 -15
- bpy/utils/units/__init__.pyi +6 -15
- bpy_extras/__init__.pyi +1 -0
- bpy_extras/anim_utils/__init__.pyi +32 -23
- bpy_extras/asset_utils/__init__.pyi +1 -0
- bpy_extras/bmesh_utils/__init__.pyi +2 -2
- bpy_extras/id_map_utils/__init__.pyi +15 -6
- bpy_extras/image_utils/__init__.pyi +3 -11
- bpy_extras/io_utils/__init__.pyi +22 -38
- bpy_extras/keyconfig_utils/__init__.pyi +5 -4
- bpy_extras/mesh_utils/__init__.pyi +3 -14
- bpy_extras/node_shader_utils/__init__.pyi +63 -70
- bpy_extras/node_utils/__init__.pyi +4 -3
- bpy_extras/object_utils/__init__.pyi +6 -19
- bpy_extras/view3d_utils/__init__.pyi +1 -18
- bpy_extras/wm_utils/__init__.pyi +1 -0
- bpy_extras/wm_utils/progress_report/__init__.pyi +12 -11
- {fake_bge_module-20250312.dist-info → fake_bge_module-20260203.dist-info}/METADATA +9 -3
- fake_bge_module-20260203.dist-info/RECORD +414 -0
- {fake_bge_module-20250312.dist-info → fake_bge_module-20260203.dist-info}/WHEEL +1 -1
- {fake_bge_module-20250312.dist-info → fake_bge_module-20260203.dist-info}/top_level.txt +16 -16
- freestyle/__init__.pyi +1 -0
- freestyle/chainingiterators/__init__.pyi +41 -60
- freestyle/functions/__init__.pyi +56 -194
- freestyle/predicates/__init__.pyi +11 -61
- freestyle/shaders/__init__.pyi +95 -156
- freestyle/types/__init__.pyi +306 -941
- freestyle/utils/ContextFunctions/__init__.pyi +4 -24
- freestyle/utils/__init__.pyi +46 -36
- gpu/__init__.pyi +84 -5
- gpu/capabilities/__init__.pyi +1 -21
- gpu/matrix/__init__.pyi +16 -24
- gpu/platform/__init__.pyi +3 -7
- gpu/select/__init__.pyi +2 -1
- gpu/shader/__init__.pyi +43 -9
- gpu/state/__init__.pyi +66 -44
- gpu/texture/__init__.pyi +4 -5
- gpu/types/__init__.pyi +216 -216
- gpu_extras/__init__.pyi +1 -0
- gpu_extras/batch/__init__.pyi +2 -5
- gpu_extras/presets/__init__.pyi +9 -10
- idprop/__init__.pyi +17 -0
- idprop/types/__init__.pyi +18 -17
- imbuf/__init__.pyi +13 -9
- imbuf/types/__init__.pyi +10 -23
- keyingsets_builtins/__init__.pyi +51 -93
- mathutils/__init__.pyi +296 -2255
- mathutils/bvhtree/__init__.pyi +24 -30
- mathutils/geometry/__init__.pyi +83 -132
- mathutils/interpolate/__init__.pyi +7 -5
- mathutils/kdtree/__init__.pyi +5 -14
- mathutils/noise/__init__.pyi +62 -106
- nodeitems_builtins/__init__.pyi +5 -4
- nodeitems_utils/__init__.pyi +10 -9
- rna_keymap_ui/__init__.pyi +7 -6
- rna_prop_ui/__init__.pyi +14 -13
- _bpy_internal/freedesktop/__init__.pyi +0 -20
- bgl/__init__.pyi +0 -4235
- bl_i18n_utils/bl_extract_messages/__init__.pyi +0 -24
- bl_i18n_utils/utils_cli/__init__.pyi +0 -10
- bl_previews_utils/bl_previews_render/__init__.pyi +0 -11
- bl_text_utils/external_editor/__init__.pyi +0 -5
- bpy_types/__init__.pyi +0 -29
- console_shell/__init__.pyi +0 -9
- fake_bge_module-20250312.dist-info/RECORD +0 -395
- keyingsets_utils/__init__.pyi +0 -18
- {animsys_refactor → _animsys_refactor}/py.typed +0 -0
- {bgl → _bl_console_utils}/py.typed +0 -0
- {bl_console_utils → _bl_i18n_utils}/py.typed +0 -0
- {bl_i18n_utils → _bl_previews_utils}/py.typed +0 -0
- {bl_previews_utils → _bl_rna_utils}/py.typed +0 -0
- {bl_rna_utils → _bl_text_utils}/py.typed +0 -0
- {bl_text_utils → _bl_ui_utils}/py.typed +0 -0
- {bl_ui_utils → _blendfile_header}/py.typed +0 -0
- {bpy_restrict_state → _bpy_restrict_state}/py.typed +0 -0
- {bpy_types → _bpy_types}/py.typed +0 -0
- {console_python → _console_python}/py.typed +0 -0
- {console_shell → _console_shell}/py.typed +0 -0
- {graphviz_export → _graphviz_export}/py.typed +0 -0
- {keyingsets_utils → _keyingsets_utils}/py.typed +0 -0
- {rna_info → _rna_info}/py.typed +0 -0
- {rna_xml → _rna_xml}/py.typed +0 -0
bge/types/__init__.pyi
CHANGED
|
@@ -1,4 +1,26 @@
|
|
|
1
1
|
"""
|
|
2
|
+
Example:
|
|
3
|
+
|
|
4
|
+
```
|
|
5
|
+
void main()
|
|
6
|
+
{
|
|
7
|
+
fragColor = texture(bgl_RenderedTexture, bgl_TexCoord.xy) * vec4(0.0, 0.0, 1.0, 1.0); // will make the rendered image blueish
|
|
8
|
+
}
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Example using offsets:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
for (int i = 0; i < 9; i++) {
|
|
15
|
+
vec2 offset = g_data.coo_offset[i].xy;
|
|
16
|
+
vec4 sample = texture(bgl_RenderedTexture, bgl_TexCoord.xy + offset);
|
|
17
|
+
// ...
|
|
18
|
+
}
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[QUOTE]
|
|
22
|
+
Deprecated since upbge 0.44.
|
|
23
|
+
|
|
2
24
|
|
|
3
25
|
--------------------
|
|
4
26
|
|
|
@@ -33,6 +55,7 @@ bge.types.*
|
|
|
33
55
|
import typing
|
|
34
56
|
import collections.abc
|
|
35
57
|
import typing_extensions
|
|
58
|
+
import numpy.typing as npt
|
|
36
59
|
import aud
|
|
37
60
|
import bpy.types
|
|
38
61
|
import mathutils
|
|
@@ -43,40 +66,22 @@ class BL_ArmatureBone:
|
|
|
43
66
|
"""
|
|
44
67
|
|
|
45
68
|
name: str
|
|
46
|
-
""" bone name.
|
|
47
|
-
|
|
48
|
-
:type: str
|
|
49
|
-
"""
|
|
69
|
+
""" bone name."""
|
|
50
70
|
|
|
51
71
|
connected: bool
|
|
52
|
-
""" true when the bone head is struck to the parent's tail.
|
|
53
|
-
|
|
54
|
-
:type: bool
|
|
55
|
-
"""
|
|
72
|
+
""" true when the bone head is struck to the parent's tail."""
|
|
56
73
|
|
|
57
74
|
hinge: bool
|
|
58
|
-
""" true when bone doesn't inherit rotation or scale from parent bone.
|
|
59
|
-
|
|
60
|
-
:type: bool
|
|
61
|
-
"""
|
|
75
|
+
""" true when bone doesn't inherit rotation or scale from parent bone."""
|
|
62
76
|
|
|
63
77
|
inherit_scale: bool
|
|
64
|
-
""" true when bone inherits scaling from parent bone.
|
|
65
|
-
|
|
66
|
-
:type: bool
|
|
67
|
-
"""
|
|
78
|
+
""" true when bone inherits scaling from parent bone."""
|
|
68
79
|
|
|
69
80
|
bbone_segments: int
|
|
70
|
-
""" number of B-bone segments.
|
|
71
|
-
|
|
72
|
-
:type: int
|
|
73
|
-
"""
|
|
81
|
+
""" number of B-bone segments."""
|
|
74
82
|
|
|
75
83
|
roll: float
|
|
76
|
-
""" bone rotation around head-tail axis.
|
|
77
|
-
|
|
78
|
-
:type: float
|
|
79
|
-
"""
|
|
84
|
+
""" bone rotation around head-tail axis."""
|
|
80
85
|
|
|
81
86
|
head: typing.Any
|
|
82
87
|
""" location of head end of the bone in parent bone space."""
|
|
@@ -85,10 +90,7 @@ class BL_ArmatureBone:
|
|
|
85
90
|
""" location of head end of the bone in parent bone space."""
|
|
86
91
|
|
|
87
92
|
length: float
|
|
88
|
-
""" bone length.
|
|
89
|
-
|
|
90
|
-
:type: float
|
|
91
|
-
"""
|
|
93
|
+
""" bone length."""
|
|
92
94
|
|
|
93
95
|
arm_head: typing.Any
|
|
94
96
|
""" location of head end of the bone in armature space."""
|
|
@@ -114,10 +116,7 @@ class BL_ArmatureChannel:
|
|
|
114
116
|
"""
|
|
115
117
|
|
|
116
118
|
name: str
|
|
117
|
-
""" channel name (=bone name), read-only.
|
|
118
|
-
|
|
119
|
-
:type: str
|
|
120
|
-
"""
|
|
119
|
+
""" channel name (=bone name), read-only."""
|
|
121
120
|
|
|
122
121
|
bone: typing.Any
|
|
123
122
|
""" return the bone object corresponding to this pose channel, read-only."""
|
|
@@ -127,58 +126,31 @@ class BL_ArmatureChannel:
|
|
|
127
126
|
|
|
128
127
|
has_ik: bool
|
|
129
128
|
""" true if the bone is part of an active IK chain, read-only.
|
|
130
|
-
This flag is not set when an IK constraint is defined but not enabled (miss target information for example).
|
|
131
|
-
|
|
132
|
-
:type: bool
|
|
133
|
-
"""
|
|
129
|
+
This flag is not set when an IK constraint is defined but not enabled (miss target information for example)."""
|
|
134
130
|
|
|
135
131
|
ik_dof_x: bool
|
|
136
|
-
""" true if the bone is free to rotation in the X axis, read-only.
|
|
137
|
-
|
|
138
|
-
:type: bool
|
|
139
|
-
"""
|
|
132
|
+
""" true if the bone is free to rotation in the X axis, read-only."""
|
|
140
133
|
|
|
141
134
|
ik_dof_y: bool
|
|
142
|
-
""" true if the bone is free to rotation in the Y axis, read-only.
|
|
143
|
-
|
|
144
|
-
:type: bool
|
|
145
|
-
"""
|
|
135
|
+
""" true if the bone is free to rotation in the Y axis, read-only."""
|
|
146
136
|
|
|
147
137
|
ik_dof_z: bool
|
|
148
|
-
""" true if the bone is free to rotation in the Z axis, read-only.
|
|
149
|
-
|
|
150
|
-
:type: bool
|
|
151
|
-
"""
|
|
138
|
+
""" true if the bone is free to rotation in the Z axis, read-only."""
|
|
152
139
|
|
|
153
140
|
ik_limit_x: bool
|
|
154
|
-
""" true if a limit is imposed on X rotation, read-only.
|
|
155
|
-
|
|
156
|
-
:type: bool
|
|
157
|
-
"""
|
|
141
|
+
""" true if a limit is imposed on X rotation, read-only."""
|
|
158
142
|
|
|
159
143
|
ik_limit_y: bool
|
|
160
|
-
""" true if a limit is imposed on Y rotation, read-only.
|
|
161
|
-
|
|
162
|
-
:type: bool
|
|
163
|
-
"""
|
|
144
|
+
""" true if a limit is imposed on Y rotation, read-only."""
|
|
164
145
|
|
|
165
146
|
ik_limit_z: bool
|
|
166
|
-
""" true if a limit is imposed on Z rotation, read-only.
|
|
167
|
-
|
|
168
|
-
:type: bool
|
|
169
|
-
"""
|
|
147
|
+
""" true if a limit is imposed on Z rotation, read-only."""
|
|
170
148
|
|
|
171
149
|
ik_rot_control: bool
|
|
172
|
-
""" true if channel rotation should applied as IK constraint, read-only.
|
|
173
|
-
|
|
174
|
-
:type: bool
|
|
175
|
-
"""
|
|
150
|
+
""" true if channel rotation should applied as IK constraint, read-only."""
|
|
176
151
|
|
|
177
152
|
ik_lin_control: bool
|
|
178
|
-
""" true if channel size should applied as IK constraint, read-only.
|
|
179
|
-
|
|
180
|
-
:type: bool
|
|
181
|
-
"""
|
|
153
|
+
""" true if channel size should applied as IK constraint, read-only."""
|
|
182
154
|
|
|
183
155
|
location: typing.Any
|
|
184
156
|
""" displacement of the bone head in armature local space, read-write."""
|
|
@@ -210,40 +182,22 @@ This field is updated after the graphic render, it represents the current pose."
|
|
|
210
182
|
""" position of bone tail in armature space, read-only."""
|
|
211
183
|
|
|
212
184
|
ik_min_x: float
|
|
213
|
-
""" minimum value of X rotation in degree (<= 0) when X rotation is limited (see ik_limit_x), read-only.
|
|
214
|
-
|
|
215
|
-
:type: float
|
|
216
|
-
"""
|
|
185
|
+
""" minimum value of X rotation in degree (<= 0) when X rotation is limited (see ik_limit_x), read-only."""
|
|
217
186
|
|
|
218
187
|
ik_max_x: float
|
|
219
|
-
""" maximum value of X rotation in degree (>= 0) when X rotation is limited (see ik_limit_x), read-only.
|
|
220
|
-
|
|
221
|
-
:type: float
|
|
222
|
-
"""
|
|
188
|
+
""" maximum value of X rotation in degree (>= 0) when X rotation is limited (see ik_limit_x), read-only."""
|
|
223
189
|
|
|
224
190
|
ik_min_y: float
|
|
225
|
-
""" minimum value of Y rotation in degree (<= 0) when Y rotation is limited (see ik_limit_y), read-only.
|
|
226
|
-
|
|
227
|
-
:type: float
|
|
228
|
-
"""
|
|
191
|
+
""" minimum value of Y rotation in degree (<= 0) when Y rotation is limited (see ik_limit_y), read-only."""
|
|
229
192
|
|
|
230
193
|
ik_max_y: float
|
|
231
|
-
""" maximum value of Y rotation in degree (>= 0) when Y rotation is limited (see ik_limit_y), read-only.
|
|
232
|
-
|
|
233
|
-
:type: float
|
|
234
|
-
"""
|
|
194
|
+
""" maximum value of Y rotation in degree (>= 0) when Y rotation is limited (see ik_limit_y), read-only."""
|
|
235
195
|
|
|
236
196
|
ik_min_z: float
|
|
237
|
-
""" minimum value of Z rotation in degree (<= 0) when Z rotation is limited (see ik_limit_z), read-only.
|
|
238
|
-
|
|
239
|
-
:type: float
|
|
240
|
-
"""
|
|
197
|
+
""" minimum value of Z rotation in degree (<= 0) when Z rotation is limited (see ik_limit_z), read-only."""
|
|
241
198
|
|
|
242
199
|
ik_max_z: float
|
|
243
|
-
""" maximum value of Z rotation in degree (>= 0) when Z rotation is limited (see ik_limit_z), read-only.
|
|
244
|
-
|
|
245
|
-
:type: float
|
|
246
|
-
"""
|
|
200
|
+
""" maximum value of Z rotation in degree (>= 0) when Z rotation is limited (see ik_limit_z), read-only."""
|
|
247
201
|
|
|
248
202
|
ik_stiffness_x: typing.Any
|
|
249
203
|
""" bone rotation stiffness in X axis, read-only."""
|
|
@@ -255,10 +209,7 @@ This field is updated after the graphic render, it represents the current pose."
|
|
|
255
209
|
""" bone rotation stiffness in Z axis, read-only."""
|
|
256
210
|
|
|
257
211
|
ik_stretch: float
|
|
258
|
-
""" ratio of scale change that is allowed, 0=bone can't change size, read-only.
|
|
259
|
-
|
|
260
|
-
:type: float
|
|
261
|
-
"""
|
|
212
|
+
""" ratio of scale change that is allowed, 0=bone can't change size, read-only."""
|
|
262
213
|
|
|
263
214
|
ik_rot_weight: typing.Any
|
|
264
215
|
""" weight of rotation constraint when ik_rot_control is set, read-write."""
|
|
@@ -275,31 +226,19 @@ class BL_ArmatureConstraint:
|
|
|
275
226
|
"""
|
|
276
227
|
|
|
277
228
|
type: int
|
|
278
|
-
""" Type of constraint, (read-only).Use one of `these constants<armatureconstraint-constants-type>`.
|
|
279
|
-
|
|
280
|
-
:type: int
|
|
281
|
-
"""
|
|
229
|
+
""" Type of constraint, (read-only).Use one of `these constants<armatureconstraint-constants-type>`."""
|
|
282
230
|
|
|
283
231
|
name: str
|
|
284
|
-
""" Name of constraint constructed as <bone_name>:<constraint_name>. constraints list.This name is also the key subscript on `~bge.types.BL_ArmatureObject`.
|
|
285
|
-
|
|
286
|
-
:type: str
|
|
287
|
-
"""
|
|
232
|
+
""" Name of constraint constructed as <bone_name>:<constraint_name>. constraints list.This name is also the key subscript on `~bge.types.BL_ArmatureObject`."""
|
|
288
233
|
|
|
289
234
|
enforce: float
|
|
290
|
-
""" fraction of constraint effect that is enforced. Between 0 and 1.
|
|
291
|
-
|
|
292
|
-
:type: float
|
|
293
|
-
"""
|
|
235
|
+
""" fraction of constraint effect that is enforced. Between 0 and 1."""
|
|
294
236
|
|
|
295
237
|
headtail: typing.Any
|
|
296
238
|
""" Position of target between head and tail of the target bone: 0=head, 1=tail."""
|
|
297
239
|
|
|
298
240
|
lin_error: float
|
|
299
|
-
""" runtime linear error (in Blender units) on constraint at the current frame.This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.
|
|
300
|
-
|
|
301
|
-
:type: float
|
|
302
|
-
"""
|
|
241
|
+
""" runtime linear error (in Blender units) on constraint at the current frame.This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver."""
|
|
303
242
|
|
|
304
243
|
rot_error: typing.Any
|
|
305
244
|
""" Runtime rotation error (in radiant) on constraint at the current frame.This is a runtime value updated on each frame by the IK solver. Only available on IK constraint and iTaSC solver.It is only set if the constraint has a rotation part, for example, a CopyPose+Rotation IK constraint."""
|
|
@@ -311,40 +250,22 @@ class BL_ArmatureConstraint:
|
|
|
311
250
|
""" Secondary target object for the constraint. The position of this object in the GE will be used as secondary target for the constraint.Currently this is only used for pole target on IK constraint."""
|
|
312
251
|
|
|
313
252
|
active: bool
|
|
314
|
-
""" True if the constraint is active.
|
|
315
|
-
|
|
316
|
-
:type: bool
|
|
317
|
-
"""
|
|
253
|
+
""" True if the constraint is active."""
|
|
318
254
|
|
|
319
255
|
ik_weight: float
|
|
320
|
-
""" Weight of the IK constraint between 0 and 1.Only defined for IK constraint.
|
|
321
|
-
|
|
322
|
-
:type: float
|
|
323
|
-
"""
|
|
256
|
+
""" Weight of the IK constraint between 0 and 1.Only defined for IK constraint."""
|
|
324
257
|
|
|
325
258
|
ik_type: int
|
|
326
|
-
""" Type of IK constraint, (read-only).Use one of `these constants<armatureconstraint-constants-ik-type>`.
|
|
327
|
-
|
|
328
|
-
:type: int
|
|
329
|
-
"""
|
|
259
|
+
""" Type of IK constraint, (read-only).Use one of `these constants<armatureconstraint-constants-ik-type>`."""
|
|
330
260
|
|
|
331
261
|
ik_flag: int
|
|
332
|
-
""" Combination of IK constraint option flags, read-only.Use one of `these constants<armatureconstraint-constants-ik-flag>`.
|
|
333
|
-
|
|
334
|
-
:type: int
|
|
335
|
-
"""
|
|
262
|
+
""" Combination of IK constraint option flags, read-only.Use one of `these constants<armatureconstraint-constants-ik-flag>`."""
|
|
336
263
|
|
|
337
264
|
ik_dist: float
|
|
338
|
-
""" Distance the constraint is trying to maintain with target, only used when ik_type=CONSTRAINT_IK_DISTANCE.
|
|
339
|
-
|
|
340
|
-
:type: float
|
|
341
|
-
"""
|
|
265
|
+
""" Distance the constraint is trying to maintain with target, only used when ik_type=CONSTRAINT_IK_DISTANCE."""
|
|
342
266
|
|
|
343
267
|
ik_mode: int
|
|
344
|
-
""" Use one of `these constants<armatureconstraint-constants-ik-mode>`.Additional mode for IK constraint. Currently only used for Distance constraint:
|
|
345
|
-
|
|
346
|
-
:type: int
|
|
347
|
-
"""
|
|
268
|
+
""" Use one of `these constants<armatureconstraint-constants-ik-mode>`.Additional mode for IK constraint. Currently only used for Distance constraint:"""
|
|
348
269
|
|
|
349
270
|
class BL_ArmatureObject:
|
|
350
271
|
"""An armature object."""
|
|
@@ -358,14 +279,14 @@ The key format for string access is '<bone_name>:<constraint_name>'."""
|
|
|
358
279
|
""" The list of armature channels.
|
|
359
280
|
Elements of the list can be accessed by index or name the bone."""
|
|
360
281
|
|
|
361
|
-
def update(self):
|
|
282
|
+
def update(self) -> None:
|
|
362
283
|
"""Ensures that the armature will be updated on next graphic frame.This action is unnecessary if a KX_ArmatureActuator with mode run is active
|
|
363
284
|
or if an action is playing. Use this function in other cases. It must be called
|
|
364
285
|
on each frame to ensure that the armature is updated continuously.
|
|
365
286
|
|
|
366
287
|
"""
|
|
367
288
|
|
|
368
|
-
def draw(self):
|
|
289
|
+
def draw(self) -> None:
|
|
369
290
|
"""Draw lines that represent armature to view it in real time."""
|
|
370
291
|
|
|
371
292
|
class BL_Shader:
|
|
@@ -440,61 +361,51 @@ class BL_Shader:
|
|
|
440
361
|
"""
|
|
441
362
|
|
|
442
363
|
enabled: bool
|
|
443
|
-
""" Set shader enabled to use.
|
|
444
|
-
|
|
445
|
-
:type: bool
|
|
446
|
-
"""
|
|
364
|
+
""" Set shader enabled to use."""
|
|
447
365
|
|
|
448
366
|
objectCallbacks: typing.Any
|
|
449
367
|
bindCallbacks: typing.Any
|
|
450
368
|
|
|
451
|
-
def setUniformfv(self, name: str, fList: list[float]):
|
|
369
|
+
def setUniformfv(self, name: str, fList: list[float]) -> None:
|
|
452
370
|
"""Set a uniform with a list of float values
|
|
453
371
|
|
|
454
372
|
:param name: the uniform name
|
|
455
|
-
:type name: str
|
|
456
373
|
:param fList: a list (2, 3 or 4 elements) of float values
|
|
457
|
-
:type fList: list[float]
|
|
458
374
|
"""
|
|
459
375
|
|
|
460
|
-
def delSource(self): ...
|
|
376
|
+
def delSource(self) -> None: ...
|
|
461
377
|
def getFragmentProg(self) -> str:
|
|
462
378
|
"""Returns the fragment program.
|
|
463
379
|
|
|
464
380
|
:return: The fragment program.
|
|
465
|
-
:rtype: str
|
|
466
381
|
"""
|
|
467
382
|
|
|
468
383
|
def getVertexProg(self) -> str:
|
|
469
384
|
"""Get the vertex program.
|
|
470
385
|
|
|
471
386
|
:return: The vertex program.
|
|
472
|
-
:rtype: str
|
|
473
387
|
"""
|
|
474
388
|
|
|
475
389
|
def isValid(self) -> bool:
|
|
476
390
|
"""Check if the shader is valid.
|
|
477
391
|
|
|
478
392
|
:return: True if the shader is valid
|
|
479
|
-
:rtype: bool
|
|
480
393
|
"""
|
|
481
394
|
|
|
482
|
-
def setAttrib(self, enum):
|
|
395
|
+
def setAttrib(self, enum) -> None:
|
|
483
396
|
"""
|
|
484
397
|
|
|
485
398
|
:param enum:
|
|
486
399
|
"""
|
|
487
400
|
|
|
488
|
-
def setSampler(self, name: str, index: int):
|
|
401
|
+
def setSampler(self, name: str, index: int) -> None:
|
|
489
402
|
"""Set uniform texture sample index.
|
|
490
403
|
|
|
491
404
|
:param name: Uniform name
|
|
492
|
-
:type name: str
|
|
493
405
|
:param index: Texture sample index.
|
|
494
|
-
:type index: int
|
|
495
406
|
"""
|
|
496
407
|
|
|
497
|
-
def setSource(self, vertexProgram, fragmentProgram, apply):
|
|
408
|
+
def setSource(self, vertexProgram, fragmentProgram, apply) -> None:
|
|
498
409
|
"""
|
|
499
410
|
|
|
500
411
|
:param vertexProgram:
|
|
@@ -502,169 +413,132 @@ class BL_Shader:
|
|
|
502
413
|
:param apply:
|
|
503
414
|
"""
|
|
504
415
|
|
|
505
|
-
def setSourceList(self, sources, apply):
|
|
416
|
+
def setSourceList(self, sources, apply) -> None:
|
|
506
417
|
"""
|
|
507
418
|
|
|
508
419
|
:param sources:
|
|
509
420
|
:param apply:
|
|
510
421
|
"""
|
|
511
422
|
|
|
512
|
-
def setUniform1f(self, name: str, fx: float):
|
|
423
|
+
def setUniform1f(self, name: str, fx: float) -> None:
|
|
513
424
|
"""Set a uniform with 1 float value.
|
|
514
425
|
|
|
515
426
|
:param name: the uniform name
|
|
516
|
-
:type name: str
|
|
517
427
|
:param fx: Uniform value
|
|
518
|
-
:type fx: float
|
|
519
428
|
"""
|
|
520
429
|
|
|
521
|
-
def setUniform1i(self, name: str, ix: int):
|
|
430
|
+
def setUniform1i(self, name: str, ix: int) -> None:
|
|
522
431
|
"""Set a uniform with an integer value.
|
|
523
432
|
|
|
524
433
|
:param name: the uniform name
|
|
525
|
-
:type name: str
|
|
526
434
|
:param ix: the uniform value
|
|
527
|
-
:type ix: int
|
|
528
435
|
"""
|
|
529
436
|
|
|
530
|
-
def setUniform2f(self, name: str, fx: float, fy: float):
|
|
437
|
+
def setUniform2f(self, name: str, fx: float, fy: float) -> None:
|
|
531
438
|
"""Set a uniform with 2 float values
|
|
532
439
|
|
|
533
440
|
:param name: the uniform name
|
|
534
|
-
:type name: str
|
|
535
441
|
:param fx: first float value
|
|
536
|
-
:type fx: float
|
|
537
442
|
:param fy: second float value
|
|
538
|
-
:type fy: float
|
|
539
443
|
"""
|
|
540
444
|
|
|
541
|
-
def setUniform2i(self, name: str, ix: int, iy: int):
|
|
445
|
+
def setUniform2i(self, name: str, ix: int, iy: int) -> None:
|
|
542
446
|
"""Set a uniform with 2 integer values
|
|
543
447
|
|
|
544
448
|
:param name: the uniform name
|
|
545
|
-
:type name: str
|
|
546
449
|
:param ix: first integer value
|
|
547
|
-
:type ix: int
|
|
548
450
|
:param iy: second integer value
|
|
549
|
-
:type iy: int
|
|
550
451
|
"""
|
|
551
452
|
|
|
552
|
-
def setUniform3f(self, name: str, fx: float, fy: float, fz: float):
|
|
453
|
+
def setUniform3f(self, name: str, fx: float, fy: float, fz: float) -> None:
|
|
553
454
|
"""Set a uniform with 3 float values.
|
|
554
455
|
|
|
555
456
|
:param name: the uniform name
|
|
556
|
-
:type name: str
|
|
557
457
|
:param fx: first float value
|
|
558
|
-
:type fx: float
|
|
559
458
|
:param fy: second float value
|
|
560
|
-
:type fy: float
|
|
561
459
|
:param fz: third float value
|
|
562
|
-
:type fz: float
|
|
563
460
|
"""
|
|
564
461
|
|
|
565
|
-
def setUniform3i(self, name: str, ix: int, iy: int, iz: int):
|
|
462
|
+
def setUniform3i(self, name: str, ix: int, iy: int, iz: int) -> None:
|
|
566
463
|
"""Set a uniform with 3 integer values
|
|
567
464
|
|
|
568
465
|
:param name: the uniform name
|
|
569
|
-
:type name: str
|
|
570
466
|
:param ix: first integer value
|
|
571
|
-
:type ix: int
|
|
572
467
|
:param iy: second integer value
|
|
573
|
-
:type iy: int
|
|
574
468
|
:param iz: third integer value
|
|
575
|
-
:type iz: int
|
|
576
469
|
"""
|
|
577
470
|
|
|
578
|
-
def setUniform4f(
|
|
471
|
+
def setUniform4f(
|
|
472
|
+
self, name: str, fx: float, fy: float, fz: float, fw: float
|
|
473
|
+
) -> None:
|
|
579
474
|
"""Set a uniform with 4 float values.
|
|
580
475
|
|
|
581
476
|
:param name: the uniform name
|
|
582
|
-
:type name: str
|
|
583
477
|
:param fx: first float value
|
|
584
|
-
:type fx: float
|
|
585
478
|
:param fy: second float value
|
|
586
|
-
:type fy: float
|
|
587
479
|
:param fz: third float value
|
|
588
|
-
:type fz: float
|
|
589
480
|
:param fw: fourth float value
|
|
590
|
-
:type fw: float
|
|
591
481
|
"""
|
|
592
482
|
|
|
593
|
-
def setUniform4i(self, name: str, ix: int, iy: int, iz: int, iw: int):
|
|
483
|
+
def setUniform4i(self, name: str, ix: int, iy: int, iz: int, iw: int) -> None:
|
|
594
484
|
"""Set a uniform with 4 integer values
|
|
595
485
|
|
|
596
486
|
:param name: the uniform name
|
|
597
|
-
:type name: str
|
|
598
487
|
:param ix: first integer value
|
|
599
|
-
:type ix: int
|
|
600
488
|
:param iy: second integer value
|
|
601
|
-
:type iy: int
|
|
602
489
|
:param iz: third integer value
|
|
603
|
-
:type iz: int
|
|
604
490
|
:param iw: fourth integer value
|
|
605
|
-
:type iw: int
|
|
606
491
|
"""
|
|
607
492
|
|
|
608
|
-
def setUniformDef(self, name: str, type: int):
|
|
493
|
+
def setUniformDef(self, name: str, type: int) -> None:
|
|
609
494
|
"""Define a new uniform
|
|
610
495
|
|
|
611
496
|
:param name: the uniform name
|
|
612
|
-
:type name: str
|
|
613
497
|
:param type: uniform type, one of `these constants <shader-defined-uniform>`
|
|
614
|
-
:type type: int
|
|
615
498
|
"""
|
|
616
499
|
|
|
617
|
-
def setUniformMatrix3(self, name: str, mat, transpose: bool):
|
|
500
|
+
def setUniformMatrix3(self, name: str, mat, transpose: bool) -> None:
|
|
618
501
|
"""Set a uniform with a 3x3 matrix value
|
|
619
502
|
|
|
620
503
|
:param name: the uniform name
|
|
621
|
-
:type name: str
|
|
622
504
|
:param mat: A 3x3 matrix [[f, f, f], [f, f, f], [f, f, f]]
|
|
623
505
|
:param transpose: set to True to transpose the matrix
|
|
624
|
-
:type transpose: bool
|
|
625
506
|
"""
|
|
626
507
|
|
|
627
|
-
def setUniformMatrix4(self, name: str, mat, transpose: bool):
|
|
508
|
+
def setUniformMatrix4(self, name: str, mat, transpose: bool) -> None:
|
|
628
509
|
"""Set a uniform with a 4x4 matrix value
|
|
629
510
|
|
|
630
511
|
:param name: the uniform name
|
|
631
|
-
:type name: str
|
|
632
512
|
:param mat: A 4x4 matrix [[f, f, f, f], [f, f, f, f], [f, f, f, f], [f, f, f, f]]
|
|
633
513
|
:param transpose: set to True to transpose the matrix
|
|
634
|
-
:type transpose: bool
|
|
635
514
|
"""
|
|
636
515
|
|
|
637
|
-
def setUniformiv(self, name: str, iList: list[int]):
|
|
516
|
+
def setUniformiv(self, name: str, iList: list[int]) -> None:
|
|
638
517
|
"""Set a uniform with a list of integer values
|
|
639
518
|
|
|
640
519
|
:param name: the uniform name
|
|
641
|
-
:type name: str
|
|
642
520
|
:param iList: a list (2, 3 or 4 elements) of integer values
|
|
643
|
-
:type iList: list[int]
|
|
644
521
|
"""
|
|
645
522
|
|
|
646
|
-
def setUniformEyef(self, name):
|
|
523
|
+
def setUniformEyef(self, name) -> None:
|
|
647
524
|
"""
|
|
648
525
|
|
|
649
526
|
:param name:
|
|
650
527
|
"""
|
|
651
528
|
|
|
652
|
-
def validate(self):
|
|
529
|
+
def validate(self) -> None:
|
|
653
530
|
"""Validate the shader object."""
|
|
654
531
|
|
|
655
532
|
class EXP_Value:
|
|
656
533
|
"""This class is a basis for other classes."""
|
|
657
534
|
|
|
658
535
|
name: str
|
|
659
|
-
""" The name of this EXP_Value derived object (read-only).
|
|
660
|
-
|
|
661
|
-
:type: str
|
|
662
|
-
"""
|
|
536
|
+
""" The name of this EXP_Value derived object (read-only)."""
|
|
663
537
|
|
|
664
538
|
class EXP_ListValue:
|
|
665
539
|
"""This is a list like object used in the game engine internally that behaves similar to a python list in most ways.As well as the normal index lookup (val= clist[i]), EXP_ListValue supports string lookups (val= scene.objects["Cube"])Other operations such as len(clist), list(clist), clist[0:10] are also supported."""
|
|
666
540
|
|
|
667
|
-
def append(self, val):
|
|
541
|
+
def append(self, val) -> None:
|
|
668
542
|
"""Add an item to the list (like pythons append)
|
|
669
543
|
|
|
670
544
|
:param val:
|
|
@@ -675,7 +549,6 @@ class EXP_ListValue:
|
|
|
675
549
|
|
|
676
550
|
:param val:
|
|
677
551
|
:return: number of instances
|
|
678
|
-
:rtype: int
|
|
679
552
|
"""
|
|
680
553
|
|
|
681
554
|
def index(self, val) -> int:
|
|
@@ -683,13 +556,12 @@ class EXP_ListValue:
|
|
|
683
556
|
|
|
684
557
|
:param val:
|
|
685
558
|
:return: The index of the value in the list.
|
|
686
|
-
:rtype: int
|
|
687
559
|
"""
|
|
688
560
|
|
|
689
|
-
def reverse(self):
|
|
561
|
+
def reverse(self) -> None:
|
|
690
562
|
"""Reverse the order of the list."""
|
|
691
563
|
|
|
692
|
-
def get(self, key, default=None):
|
|
564
|
+
def get(self, key, default=None) -> None:
|
|
693
565
|
"""Return the value matching key, or the default value if its not found.
|
|
694
566
|
|
|
695
567
|
:param key:
|
|
@@ -697,7 +569,7 @@ class EXP_ListValue:
|
|
|
697
569
|
:return: The key value or a default.
|
|
698
570
|
"""
|
|
699
571
|
|
|
700
|
-
def filter(self, name, prop):
|
|
572
|
+
def filter(self, name, prop) -> None:
|
|
701
573
|
"""Return a list of items with name matching name regex and with a property matching prop regex.
|
|
702
574
|
If name is empty every items are checked, if prop is empty no property check is proceeded.
|
|
703
575
|
|
|
@@ -706,7 +578,7 @@ class EXP_ListValue:
|
|
|
706
578
|
:return: The list of matching items.
|
|
707
579
|
"""
|
|
708
580
|
|
|
709
|
-
def from_id(self, id):
|
|
581
|
+
def from_id(self, id) -> None:
|
|
710
582
|
"""This is a function especially for the game engine to return a value with a specific id.Since object names are not always unique, the id of an object can be used to get an object from the CValueList.Example:Where myObID is an int or long from the id function.This has the advantage that you can store the id in places you could not store a gameObject.
|
|
711
583
|
|
|
712
584
|
:param id:
|
|
@@ -721,103 +593,28 @@ class EXP_PyObjectPlus:
|
|
|
721
593
|
invalid: bool
|
|
722
594
|
""" Test if the object has been freed by the game engine and is no longer valid.Normally this is not a problem but when storing game engine data in the GameLogic module,
|
|
723
595
|
KX_Scenes or other KX_GameObjects its possible to hold a reference to invalid data.
|
|
724
|
-
Calling an attribute or method on an invalid object will raise a SystemError.The invalid attribute allows testing for this case without exception handling.
|
|
725
|
-
|
|
726
|
-
:type: bool
|
|
727
|
-
"""
|
|
596
|
+
Calling an attribute or method on an invalid object will raise a SystemError.The invalid attribute allows testing for this case without exception handling."""
|
|
728
597
|
|
|
729
598
|
class KX_2DFilter:
|
|
730
|
-
"""2D filter shader object. Can be alternated with `~bge.types.BL_Shader`
|
|
731
|
-
|
|
732
|
-
mipmap: bool
|
|
733
|
-
""" Request mipmap generation of the render bgl_RenderedTexture texture. Accessing mipmapping level is similar to:
|
|
734
|
-
|
|
735
|
-
:type: bool
|
|
736
|
-
"""
|
|
737
|
-
|
|
738
|
-
offScreen: typing.Any
|
|
739
|
-
""" The custom off screen (framebuffer in 0.3.0) the filter render to (read-only)."""
|
|
740
|
-
|
|
741
|
-
def setTexture(self, index: int, bindCode: int, samplerName: str = ""):
|
|
742
|
-
"""Set specified texture bind code `bindCode` in specified slot `index`. Any call to `setTexture`
|
|
743
|
-
should be followed by a call to `BL_Shader.setSampler <bge.types.BL_Shader.setSampler>` with the same `index` if `sampleName` is not specified.
|
|
744
|
-
|
|
745
|
-
:param index: The texture slot.
|
|
746
|
-
:type index: int
|
|
747
|
-
:param bindCode: The texture bind code/Id.
|
|
748
|
-
:type bindCode: int
|
|
749
|
-
:param samplerName: The shader sampler name set to `index` if `samplerName` is passed in the function. (optional)
|
|
750
|
-
:type samplerName: str
|
|
751
|
-
"""
|
|
752
|
-
|
|
753
|
-
def setCubeMap(self, index: int, bindCode: int, samplerName: str = ""):
|
|
754
|
-
"""Set specified cube map texture bind code `bindCode` in specified slot `index`. Any call to `setCubeMap`
|
|
755
|
-
should be followed by a call to `BL_Shader.setSampler <bge.types.BL_Shader.setSampler>` with the same `index` if `sampleName` is not specified.
|
|
756
|
-
|
|
757
|
-
:param index: The texture slot.
|
|
758
|
-
:type index: int
|
|
759
|
-
:param bindCode: The cube map texture bind code/Id.
|
|
760
|
-
:type bindCode: int
|
|
761
|
-
:param samplerName: The shader sampler name set to `index` if `samplerName` is passed in the function. (optional)
|
|
762
|
-
:type samplerName: str
|
|
763
|
-
"""
|
|
764
|
-
|
|
765
|
-
def addOffScreen(
|
|
766
|
-
self,
|
|
767
|
-
slots: int,
|
|
768
|
-
width: int | None = None,
|
|
769
|
-
height: int | None = None,
|
|
770
|
-
mipmap: bool = False,
|
|
771
|
-
):
|
|
772
|
-
"""Register a custom off screen (framebuffer in 0.3.0) to render the filter to.
|
|
773
|
-
|
|
774
|
-
:param slots: The number of color texture attached to the off screen, between 0 and 8 excluded.
|
|
775
|
-
:type slots: int
|
|
776
|
-
:param width: In 0.3.0, always canvas width (optional).
|
|
777
|
-
:type width: int | None
|
|
778
|
-
:param height: In 0.3.0, always canvas height (optional).
|
|
779
|
-
:type height: int | None
|
|
780
|
-
:param mipmap: True if the color texture generate mipmap at the end of the filter rendering (optional).
|
|
781
|
-
:type mipmap: bool
|
|
782
|
-
"""
|
|
783
|
-
|
|
784
|
-
def removeOffScreen(self):
|
|
785
|
-
"""Unregister the custom off screen (framebuffer in 0.3.0) the filter render to."""
|
|
599
|
+
"""2D filter shader object. Can be alternated with `~bge.types.BL_Shader`s functions."""
|
|
786
600
|
|
|
787
601
|
class KX_2DFilterFrameBuffer:
|
|
788
|
-
"""2D filter custom off screen (framebuffer in 0.3
|
|
602
|
+
"""2D filter custom off screen (framebuffer in 0.3+)."""
|
|
789
603
|
|
|
790
604
|
width: int
|
|
791
|
-
""" The off screen width, always canvas width in 0.3
|
|
792
|
-
|
|
793
|
-
:type: int
|
|
794
|
-
"""
|
|
605
|
+
""" The off screen width, always canvas width in 0.3+ (read-only)."""
|
|
795
606
|
|
|
796
607
|
height: int
|
|
797
|
-
""" The off screen height, always canvas height in 0.3
|
|
798
|
-
|
|
799
|
-
:type: int
|
|
800
|
-
"""
|
|
801
|
-
|
|
802
|
-
colorBindCodes: typing.Any
|
|
803
|
-
""" The bind code of the color textures attached to the off screen (read-only)."""
|
|
608
|
+
""" The off screen height, always canvas height in 0.3+ (read-only)."""
|
|
804
609
|
|
|
805
|
-
|
|
806
|
-
|
|
610
|
+
def getColorTexture(self) -> None:
|
|
611
|
+
"""Returns the buffer color texture.
|
|
807
612
|
|
|
808
|
-
:type: int
|
|
809
|
-
"""
|
|
810
|
-
|
|
811
|
-
def getColorTexture(self, slot: int = 0):
|
|
812
|
-
"""Returns the color buffer as texture.
|
|
813
|
-
|
|
814
|
-
:param slot: index of the slot (0-7).
|
|
815
|
-
:type slot: int
|
|
816
613
|
:return: Texture object.
|
|
817
614
|
"""
|
|
818
615
|
|
|
819
|
-
def getDepthTexture(self):
|
|
820
|
-
"""Returns the
|
|
616
|
+
def getDepthTexture(self) -> None:
|
|
617
|
+
"""Returns the buffer depth texture.
|
|
821
618
|
|
|
822
619
|
:return: Texture object.
|
|
823
620
|
"""
|
|
@@ -825,11 +622,12 @@ class KX_2DFilterFrameBuffer:
|
|
|
825
622
|
class KX_2DFilterManager:
|
|
826
623
|
"""2D filter manager used to add, remove and find filters in a scene."""
|
|
827
624
|
|
|
828
|
-
def addFilter(
|
|
625
|
+
def addFilter(
|
|
626
|
+
self, index: int, type: int, fragmentProgram: str | None = ""
|
|
627
|
+
) -> None:
|
|
829
628
|
"""Add a filter to the pass index `index`, type `type` and fragment program if custom filter.
|
|
830
629
|
|
|
831
630
|
:param index: The filter pass index.
|
|
832
|
-
:type index: int
|
|
833
631
|
:param type: The filter type, one of:
|
|
834
632
|
|
|
835
633
|
`bge.logic.RAS_2DFILTER_BLUR`
|
|
@@ -851,25 +649,21 @@ class KX_2DFilterManager:
|
|
|
851
649
|
`bge.logic.RAS_2DFILTER_SEPIA`
|
|
852
650
|
|
|
853
651
|
`bge.logic.RAS_2DFILTER_CUSTOMFILTER`
|
|
854
|
-
:type type: int
|
|
855
652
|
:param fragmentProgram: The filter shader fragment program.
|
|
856
653
|
Specified only if `type` is `bge.logic.RAS_2DFILTER_CUSTOMFILTER`. (optional)
|
|
857
|
-
:type fragmentProgram: str | None
|
|
858
654
|
:return: The 2D Filter.
|
|
859
655
|
"""
|
|
860
656
|
|
|
861
|
-
def removeFilter(self, index: int):
|
|
657
|
+
def removeFilter(self, index: int) -> None:
|
|
862
658
|
"""Remove filter to the pass index `index`.
|
|
863
659
|
|
|
864
660
|
:param index: The filter pass index.
|
|
865
|
-
:type index: int
|
|
866
661
|
"""
|
|
867
662
|
|
|
868
|
-
def getFilter(self, index: int):
|
|
663
|
+
def getFilter(self, index: int) -> None:
|
|
869
664
|
"""Return filter to the pass index `index`.
|
|
870
665
|
|
|
871
666
|
:param index: The filter pass index.
|
|
872
|
-
:type index: int
|
|
873
667
|
:return: The filter in the specified pass index or None.
|
|
874
668
|
"""
|
|
875
669
|
|
|
@@ -892,60 +686,33 @@ class KX_Camera:
|
|
|
892
686
|
""" See `sphereInsideFrustum` and `boxInsideFrustum`"""
|
|
893
687
|
|
|
894
688
|
lens: float
|
|
895
|
-
""" The camera's lens value.
|
|
896
|
-
|
|
897
|
-
:type: float
|
|
898
|
-
"""
|
|
689
|
+
""" The camera's lens value."""
|
|
899
690
|
|
|
900
691
|
lodDistanceFactor: float
|
|
901
692
|
""" The factor to multiply distance to camera to adjust levels of detail.
|
|
902
693
|
A float < 1.0f will make the distance to camera used to compute
|
|
903
|
-
levels of detail decrease.
|
|
904
|
-
|
|
905
|
-
:type: float
|
|
906
|
-
"""
|
|
694
|
+
levels of detail decrease."""
|
|
907
695
|
|
|
908
696
|
fov: float
|
|
909
|
-
""" The camera's field of view value.
|
|
910
|
-
|
|
911
|
-
:type: float
|
|
912
|
-
"""
|
|
697
|
+
""" The camera's field of view value."""
|
|
913
698
|
|
|
914
699
|
ortho_scale: float
|
|
915
|
-
""" The camera's view scale when in orthographic mode.
|
|
916
|
-
|
|
917
|
-
:type: float
|
|
918
|
-
"""
|
|
700
|
+
""" The camera's view scale when in orthographic mode."""
|
|
919
701
|
|
|
920
702
|
near: float
|
|
921
|
-
""" The camera's near clip distance.
|
|
922
|
-
|
|
923
|
-
:type: float
|
|
924
|
-
"""
|
|
703
|
+
""" The camera's near clip distance."""
|
|
925
704
|
|
|
926
705
|
far: float
|
|
927
|
-
""" The camera's far clip distance.
|
|
928
|
-
|
|
929
|
-
:type: float
|
|
930
|
-
"""
|
|
706
|
+
""" The camera's far clip distance."""
|
|
931
707
|
|
|
932
708
|
shift_x: float
|
|
933
|
-
""" The camera's horizontal shift.
|
|
934
|
-
|
|
935
|
-
:type: float
|
|
936
|
-
"""
|
|
709
|
+
""" The camera's horizontal shift."""
|
|
937
710
|
|
|
938
711
|
shift_y: float
|
|
939
|
-
""" The camera's vertical shift.
|
|
940
|
-
|
|
941
|
-
:type: float
|
|
942
|
-
"""
|
|
712
|
+
""" The camera's vertical shift."""
|
|
943
713
|
|
|
944
714
|
perspective: bool
|
|
945
|
-
""" True if this camera has a perspective transform, False for an orthographic projection.
|
|
946
|
-
|
|
947
|
-
:type: bool
|
|
948
|
-
"""
|
|
715
|
+
""" True if this camera has a perspective transform, False for an orthographic projection."""
|
|
949
716
|
|
|
950
717
|
projection_matrix: typing.Any
|
|
951
718
|
""" This camera's 4x4 projection matrix."""
|
|
@@ -960,28 +727,20 @@ levels of detail decrease.
|
|
|
960
727
|
""" This camera's world to camera transform. (read-only)."""
|
|
961
728
|
|
|
962
729
|
useViewport: bool
|
|
963
|
-
""" True when the camera is used as a viewport, set True to enable a viewport for this camera.
|
|
964
|
-
|
|
965
|
-
:type: bool
|
|
966
|
-
"""
|
|
730
|
+
""" True when the camera is used as a viewport, set True to enable a viewport for this camera."""
|
|
967
731
|
|
|
968
732
|
activityCulling: bool
|
|
969
|
-
""" True if this camera is used to compute object distance for object activity culling.
|
|
970
|
-
|
|
971
|
-
:type: bool
|
|
972
|
-
"""
|
|
733
|
+
""" True if this camera is used to compute object distance for object activity culling."""
|
|
973
734
|
|
|
974
735
|
def sphereInsideFrustum(self, centre, radius: float) -> int:
|
|
975
736
|
"""Tests the given sphere against the view frustum.
|
|
976
737
|
|
|
977
738
|
:param centre: The centre of the sphere (in world coordinates.)
|
|
978
739
|
:param radius: the radius of the sphere
|
|
979
|
-
:type radius: float
|
|
980
740
|
:return: `~bge.types.KX_Camera.INSIDE`, `~bge.types.KX_Camera.OUTSIDE` or `~bge.types.KX_Camera.INTERSECT`
|
|
981
|
-
:rtype: int
|
|
982
741
|
"""
|
|
983
742
|
|
|
984
|
-
def boxInsideFrustum(self, box):
|
|
743
|
+
def boxInsideFrustum(self, box) -> None:
|
|
985
744
|
"""Tests the given box against the view frustum.
|
|
986
745
|
|
|
987
746
|
:param box: Eight (8) corner points of the box (in world coordinates.)
|
|
@@ -994,47 +753,40 @@ levels of detail decrease.
|
|
|
994
753
|
"""Tests the given point against the view frustum.
|
|
995
754
|
|
|
996
755
|
:param point: The point to test (in world coordinates.)
|
|
997
|
-
:
|
|
998
|
-
:return: True if the given point is inside this camera's viewing frustum.
|
|
999
|
-
:rtype: bool
|
|
756
|
+
:return: True if the given point is inside this cameras viewing frustum.
|
|
1000
757
|
"""
|
|
1001
758
|
|
|
1002
|
-
def getCameraToWorld(self):
|
|
759
|
+
def getCameraToWorld(self) -> None:
|
|
1003
760
|
"""Returns the camera-to-world transform.
|
|
1004
761
|
|
|
1005
762
|
:return: the camera-to-world transform matrix.
|
|
1006
763
|
"""
|
|
1007
764
|
|
|
1008
|
-
def getWorldToCamera(self):
|
|
765
|
+
def getWorldToCamera(self) -> None:
|
|
1009
766
|
"""Returns the world-to-camera transform.This returns the inverse matrix of getCameraToWorld().
|
|
1010
767
|
|
|
1011
768
|
:return: the world-to-camera transform matrix.
|
|
1012
769
|
"""
|
|
1013
770
|
|
|
1014
|
-
def setOnTop(self):
|
|
771
|
+
def setOnTop(self) -> None:
|
|
1015
772
|
"""Set this cameras viewport ontop of all other viewport."""
|
|
1016
773
|
|
|
1017
|
-
def setViewport(self, left: int, bottom: int, right: int, top: int):
|
|
774
|
+
def setViewport(self, left: int, bottom: int, right: int, top: int) -> None:
|
|
1018
775
|
"""Sets the region of this viewport on the screen in pixels.Use `bge.render.getWindowHeight` and `bge.render.getWindowWidth` to calculate values relative to the entire display.
|
|
1019
776
|
|
|
1020
777
|
:param left: left pixel coordinate of this viewport
|
|
1021
|
-
:type left: int
|
|
1022
778
|
:param bottom: bottom pixel coordinate of this viewport
|
|
1023
|
-
:type bottom: int
|
|
1024
779
|
:param right: right pixel coordinate of this viewport
|
|
1025
|
-
:type right: int
|
|
1026
780
|
:param top: top pixel coordinate of this viewport
|
|
1027
|
-
:type top: int
|
|
1028
781
|
"""
|
|
1029
782
|
|
|
1030
783
|
def getScreenPosition(
|
|
1031
784
|
self, object: collections.abc.Sequence[float] | mathutils.Vector
|
|
1032
|
-
):
|
|
785
|
+
) -> None:
|
|
1033
786
|
"""Gets the position of an object projected on screen space.
|
|
1034
787
|
|
|
1035
788
|
:param object: object name or list [x, y, z]
|
|
1036
|
-
:
|
|
1037
|
-
:return: the object's position in screen coordinates.
|
|
789
|
+
:return: the objects position in screen coordinates.
|
|
1038
790
|
"""
|
|
1039
791
|
|
|
1040
792
|
def getScreenVect(
|
|
@@ -1043,27 +795,20 @@ levels of detail decrease.
|
|
|
1043
795
|
"""Gets the vector from the camera position in the screen coordinate direction.
|
|
1044
796
|
|
|
1045
797
|
:param x: X Axis
|
|
1046
|
-
:type x: float
|
|
1047
798
|
:param y: Y Axis
|
|
1048
|
-
:type y: float
|
|
1049
799
|
:return: The vector from screen coordinate.
|
|
1050
|
-
:rtype: collections.abc.Sequence[float] | mathutils.Vector
|
|
1051
800
|
"""
|
|
1052
801
|
|
|
1053
802
|
def getScreenRay(
|
|
1054
803
|
self, x: float, y: float, dist: float = inf, property: str | None = None
|
|
1055
|
-
):
|
|
804
|
+
) -> None:
|
|
1056
805
|
"""Look towards a screen coordinate (x, y) and find first object hit within dist that matches prop.
|
|
1057
806
|
The ray is similar to KX_GameObject->rayCastTo.
|
|
1058
807
|
|
|
1059
808
|
:param x: X Axis
|
|
1060
|
-
:type x: float
|
|
1061
809
|
:param y: Y Axis
|
|
1062
|
-
:type y: float
|
|
1063
810
|
:param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
|
|
1064
|
-
:type dist: float
|
|
1065
811
|
:param property: property name that object must have; can be omitted => detect any object
|
|
1066
|
-
:type property: str | None
|
|
1067
812
|
:return: the first object hit or None if no object or object does not match prop
|
|
1068
813
|
"""
|
|
1069
814
|
|
|
@@ -1071,172 +816,112 @@ class KX_CharacterWrapper:
|
|
|
1071
816
|
"""A wrapper to expose character physics options."""
|
|
1072
817
|
|
|
1073
818
|
onGround: bool
|
|
1074
|
-
""" Whether or not the character is on the ground. (read-only)
|
|
1075
|
-
|
|
1076
|
-
:type: bool
|
|
1077
|
-
"""
|
|
819
|
+
""" Whether or not the character is on the ground. (read-only)"""
|
|
1078
820
|
|
|
1079
821
|
gravity: typing.Any
|
|
1080
822
|
""" The gravity vector used for the character."""
|
|
1081
823
|
|
|
1082
824
|
fallSpeed: float
|
|
1083
|
-
""" The character falling speed.
|
|
1084
|
-
|
|
1085
|
-
:type: float
|
|
1086
|
-
"""
|
|
825
|
+
""" The character falling speed."""
|
|
1087
826
|
|
|
1088
827
|
maxJumps: int
|
|
1089
|
-
""" The maximum number of jumps a character can perform before having to touch the ground. By default this is set to 1. 2 allows for a double jump, etc.
|
|
1090
|
-
|
|
1091
|
-
:type: int
|
|
1092
|
-
"""
|
|
828
|
+
""" The maximum number of jumps a character can perform before having to touch the ground. By default this is set to 1. 2 allows for a double jump, etc."""
|
|
1093
829
|
|
|
1094
830
|
jumpCount: int
|
|
1095
|
-
""" The current jump count. This can be used to have different logic for a single jump versus a double jump. For example, a different animation for the second jump.
|
|
1096
|
-
|
|
1097
|
-
:type: int
|
|
1098
|
-
"""
|
|
831
|
+
""" The current jump count. This can be used to have different logic for a single jump versus a double jump. For example, a different animation for the second jump."""
|
|
1099
832
|
|
|
1100
833
|
jumpSpeed: float
|
|
1101
|
-
""" The character jumping speed.
|
|
1102
|
-
|
|
1103
|
-
:type: float
|
|
1104
|
-
"""
|
|
834
|
+
""" The character jumping speed."""
|
|
1105
835
|
|
|
1106
836
|
maxSlope: float
|
|
1107
|
-
""" The maximum slope which the character can climb.
|
|
1108
|
-
|
|
1109
|
-
:type: float
|
|
1110
|
-
"""
|
|
837
|
+
""" The maximum slope which the character can climb."""
|
|
1111
838
|
|
|
1112
839
|
walkDirection: typing.Any
|
|
1113
840
|
""" The speed and direction the character is traveling in using world coordinates. This should be used instead of applyMovement() to properly move the character."""
|
|
1114
841
|
|
|
1115
|
-
def jump(self):
|
|
1116
|
-
"""The character jumps based on
|
|
842
|
+
def jump(self) -> None:
|
|
843
|
+
"""The character jumps based on its jump speed."""
|
|
1117
844
|
|
|
1118
845
|
def setVelocity(
|
|
1119
846
|
self,
|
|
1120
847
|
velocity: collections.abc.Sequence[float] | mathutils.Vector,
|
|
1121
848
|
time: float,
|
|
1122
849
|
local: bool = False,
|
|
1123
|
-
):
|
|
1124
|
-
"""Sets the
|
|
850
|
+
) -> None:
|
|
851
|
+
"""Sets the characters linear velocity for a given period.This method sets characters velocity through its center of mass during a period.
|
|
1125
852
|
|
|
1126
853
|
:param velocity: Linear velocity vector.
|
|
1127
|
-
:type velocity: collections.abc.Sequence[float] | mathutils.Vector
|
|
1128
854
|
:param time: Period while applying linear velocity.
|
|
1129
|
-
:type time: float
|
|
1130
855
|
:param local: False: you get the "global" velocity ie: relative to world orientation.
|
|
1131
856
|
|
|
1132
857
|
True: you get the "local" velocity ie: relative to object orientation.
|
|
1133
|
-
:type local: bool
|
|
1134
858
|
"""
|
|
1135
859
|
|
|
1136
|
-
def reset(self):
|
|
860
|
+
def reset(self) -> None:
|
|
1137
861
|
"""Resets the character velocity and walk direction."""
|
|
1138
862
|
|
|
1139
863
|
class KX_CollisionContactPoint:
|
|
1140
864
|
"""A collision contact point passed to the collision callbacks."""
|
|
1141
865
|
|
|
1142
866
|
localPointA: mathutils.Vector
|
|
1143
|
-
""" The contact point in the owner object space.
|
|
1144
|
-
|
|
1145
|
-
:type: mathutils.Vector
|
|
1146
|
-
"""
|
|
867
|
+
""" The contact point in the owner object space."""
|
|
1147
868
|
|
|
1148
869
|
localPointB: mathutils.Vector
|
|
1149
|
-
""" The contact point in the collider object space.
|
|
1150
|
-
|
|
1151
|
-
:type: mathutils.Vector
|
|
1152
|
-
"""
|
|
870
|
+
""" The contact point in the collider object space."""
|
|
1153
871
|
|
|
1154
872
|
worldPoint: mathutils.Vector
|
|
1155
|
-
""" The contact point in world space.
|
|
1156
|
-
|
|
1157
|
-
:type: mathutils.Vector
|
|
1158
|
-
"""
|
|
873
|
+
""" The contact point in world space."""
|
|
1159
874
|
|
|
1160
875
|
normal: mathutils.Vector
|
|
1161
|
-
""" The contact normal in owner object space.
|
|
1162
|
-
|
|
1163
|
-
:type: mathutils.Vector
|
|
1164
|
-
"""
|
|
876
|
+
""" The contact normal in owner object space."""
|
|
1165
877
|
|
|
1166
878
|
combinedFriction: float
|
|
1167
|
-
""" The combined friction of the owner and collider object.
|
|
1168
|
-
|
|
1169
|
-
:type: float
|
|
1170
|
-
"""
|
|
879
|
+
""" The combined friction of the owner and collider object."""
|
|
1171
880
|
|
|
1172
881
|
combinedRollingFriction: float
|
|
1173
|
-
""" The combined rolling friction of the owner and collider object.
|
|
1174
|
-
|
|
1175
|
-
:type: float
|
|
1176
|
-
"""
|
|
882
|
+
""" The combined rolling friction of the owner and collider object."""
|
|
1177
883
|
|
|
1178
884
|
combinedRestitution: float
|
|
1179
|
-
""" The combined restitution of the owner and collider object.
|
|
1180
|
-
|
|
1181
|
-
:type: float
|
|
1182
|
-
"""
|
|
885
|
+
""" The combined restitution of the owner and collider object."""
|
|
1183
886
|
|
|
1184
887
|
appliedImpulse: float
|
|
1185
|
-
""" The applied impulse to the owner object.
|
|
1186
|
-
|
|
1187
|
-
:type: float
|
|
1188
|
-
"""
|
|
888
|
+
""" The applied impulse to the owner object."""
|
|
1189
889
|
|
|
1190
890
|
class KX_ConstraintWrapper:
|
|
1191
891
|
"""KX_ConstraintWrapper"""
|
|
1192
892
|
|
|
1193
893
|
constraint_id: int
|
|
1194
|
-
""" Returns the constraint ID (read only)
|
|
1195
|
-
|
|
1196
|
-
:type: int
|
|
1197
|
-
"""
|
|
894
|
+
""" Returns the constraint ID (read only)"""
|
|
1198
895
|
|
|
1199
896
|
constraint_type: int
|
|
1200
|
-
""" Returns the constraint type (read only)
|
|
1201
|
-
|
|
1202
|
-
:type: int
|
|
1203
|
-
"""
|
|
897
|
+
""" Returns the constraint type (read only)"""
|
|
1204
898
|
|
|
1205
899
|
breakingThreshold: typing.Any
|
|
1206
900
|
""" The impulse threshold breaking the constraint, if the constraint is broken `enabled` is set to False."""
|
|
1207
901
|
|
|
1208
902
|
enabled: bool
|
|
1209
|
-
""" The status of the constraint. Set to True to restore a constraint after breaking.
|
|
1210
|
-
|
|
1211
|
-
:type: bool
|
|
1212
|
-
"""
|
|
903
|
+
""" The status of the constraint. Set to True to restore a constraint after breaking."""
|
|
1213
904
|
|
|
1214
905
|
def getConstraintId(self, val) -> int:
|
|
1215
906
|
"""Returns the constraint ID
|
|
1216
907
|
|
|
1217
908
|
:param val:
|
|
1218
909
|
:return: the constraint ID
|
|
1219
|
-
:rtype: int
|
|
1220
910
|
"""
|
|
1221
911
|
|
|
1222
|
-
def setParam(self, axis: int, value0: float, value1: float):
|
|
912
|
+
def setParam(self, axis: int, value0: float, value1: float) -> None:
|
|
1223
913
|
"""Set the constraint limitsFor PHY_LINEHINGE_CONSTRAINT = 2 or PHY_ANGULAR_CONSTRAINT = 3:For PHY_CONE_TWIST_CONSTRAINT = 4:For PHY_GENERIC_6DOF_CONSTRAINT = 12:
|
|
1224
914
|
|
|
1225
915
|
:param axis:
|
|
1226
|
-
:type axis: int
|
|
1227
916
|
:param value0: Set the minimum limit of the axisSet the minimum limit of the axisSet the minimum limit of the axisSet the linear velocity of the axisSet the stiffness of the spring
|
|
1228
|
-
:
|
|
1229
|
-
:param value1: Set the maximum limit of the axisSet the maximum limit of the axisSet the maximum limit of the axisSet the maximum force limit of the axisTendency of the spring to return to it's original position
|
|
1230
|
-
:type value1: float
|
|
917
|
+
:param value1: Set the maximum limit of the axisSet the maximum limit of the axisSet the maximum limit of the axisSet the maximum force limit of the axisTendency of the spring to return to its original position
|
|
1231
918
|
"""
|
|
1232
919
|
|
|
1233
920
|
def getParam(self, axis: int) -> float:
|
|
1234
921
|
"""Get the constraint position or euler angle of a generic 6DOF constraint
|
|
1235
922
|
|
|
1236
923
|
:param axis:
|
|
1237
|
-
:type axis: int
|
|
1238
924
|
:return: positionangle
|
|
1239
|
-
:rtype: float
|
|
1240
925
|
"""
|
|
1241
926
|
|
|
1242
927
|
class KX_FontObject:
|
|
@@ -1247,15 +932,15 @@ class KX_GameObject:
|
|
|
1247
932
|
should be used - e.g. inherit from `~bge.types.BL_ArmatureObject` when the object
|
|
1248
933
|
to mutate is an armature.The layer mask used for shadow and real-time cube map render.type
|
|
1249
934
|
|
|
1250
|
-
integer (bit mask)0.3.0(You can use bpy.types.Object.bound_box instead) The
|
|
935
|
+
integer (bit mask)0.3.0(You can use bpy.types.Object.bound_box instead) The objects bounding volume box used for culling.type
|
|
1251
936
|
|
|
1252
|
-
`~bge.types.KX_BoundingBox`0.3.0Returns True if the object is culled, else False.This variable returns an invalid value if it is called outside the
|
|
937
|
+
`~bge.types.KX_BoundingBox`0.3.0Returns True if the object is culled, else False.This variable returns an invalid value if it is called outside the scenes callbacks `KX_Scene.pre_draw <~bge.types.KX_Scene.pre_draw>` and `KX_Scene.post_draw <~bge.types.KX_Scene.post_draw>`.type
|
|
1253
938
|
|
|
1254
939
|
boolean (read only)0.3.0occlusion capability flag.type
|
|
1255
940
|
|
|
1256
941
|
boolean0.3.0The object batch group containing the batched mesh.type
|
|
1257
942
|
|
|
1258
|
-
`~bge.types.KX_BatchGroup`0.3.0Sets the game
|
|
943
|
+
`~bge.types.KX_BatchGroup`0.3.0Sets the game objects occlusion capability.arg occlusion
|
|
1259
944
|
|
|
1260
945
|
the state to set the occlusion to.
|
|
1261
946
|
|
|
@@ -1269,7 +954,7 @@ class KX_GameObject:
|
|
|
1269
954
|
|
|
1270
955
|
type recursive
|
|
1271
956
|
|
|
1272
|
-
boolean0.3.0Gets the game
|
|
957
|
+
boolean0.3.0Gets the game objects reaction force.The reaction force is the force applied to this object over the last simulation timestep.
|
|
1273
958
|
This also includes impulses, eg from collisions.return
|
|
1274
959
|
|
|
1275
960
|
the reaction force of this object.
|
|
@@ -1280,28 +965,16 @@ class KX_GameObject:
|
|
|
1280
965
|
"""
|
|
1281
966
|
|
|
1282
967
|
name: str
|
|
1283
|
-
""" The object's name.
|
|
1284
|
-
|
|
1285
|
-
:type: str
|
|
1286
|
-
"""
|
|
968
|
+
""" The object's name."""
|
|
1287
969
|
|
|
1288
970
|
mass: float
|
|
1289
|
-
""" The object's mass
|
|
1290
|
-
|
|
1291
|
-
:type: float
|
|
1292
|
-
"""
|
|
971
|
+
""" The object's mass"""
|
|
1293
972
|
|
|
1294
973
|
friction: float
|
|
1295
|
-
""" The object's friction
|
|
1296
|
-
|
|
1297
|
-
:type: float
|
|
1298
|
-
"""
|
|
974
|
+
""" The object's friction"""
|
|
1299
975
|
|
|
1300
976
|
isSuspendDynamics: bool
|
|
1301
|
-
""" The object's dynamic state (read-only).:py:meth:`suspendDynamics` and :py:meth:`restoreDynamics` allow you to change the state.
|
|
1302
|
-
|
|
1303
|
-
:type: bool
|
|
1304
|
-
"""
|
|
977
|
+
""" The object's dynamic state (read-only).:py:meth:`suspendDynamics` and :py:meth:`restoreDynamics` allow you to change the state."""
|
|
1305
978
|
|
|
1306
979
|
linearDamping: typing.Any
|
|
1307
980
|
""" The object's linear damping, also known as translational damping. Can be set simultaneously with angular damping using the `setDamping` method."""
|
|
@@ -1310,16 +983,10 @@ class KX_GameObject:
|
|
|
1310
983
|
""" The object's angular damping, also known as rotationation damping. Can be set simultaneously with linear damping using the `setDamping` method."""
|
|
1311
984
|
|
|
1312
985
|
linVelocityMin: float
|
|
1313
|
-
""" Enforces the object keeps moving at a minimum velocity.
|
|
1314
|
-
|
|
1315
|
-
:type: float
|
|
1316
|
-
"""
|
|
986
|
+
""" Enforces the object keeps moving at a minimum velocity."""
|
|
1317
987
|
|
|
1318
988
|
linVelocityMax: float
|
|
1319
|
-
""" Clamp the maximum linear velocity to prevent objects moving beyond a set speed.
|
|
1320
|
-
|
|
1321
|
-
:type: float
|
|
1322
|
-
"""
|
|
989
|
+
""" Clamp the maximum linear velocity to prevent objects moving beyond a set speed."""
|
|
1323
990
|
|
|
1324
991
|
angularVelocityMin: typing.Any
|
|
1325
992
|
""" Enforces the object keeps rotating at a minimum velocity. A value of 0.0 disables this."""
|
|
@@ -1356,182 +1023,101 @@ and third argument."""
|
|
|
1356
1023
|
""" The object's scene. (read-only)."""
|
|
1357
1024
|
|
|
1358
1025
|
visible: bool
|
|
1359
|
-
""" visibility flag.
|
|
1360
|
-
|
|
1361
|
-
:type: bool
|
|
1362
|
-
"""
|
|
1026
|
+
""" visibility flag."""
|
|
1363
1027
|
|
|
1364
1028
|
layer: typing.Any
|
|
1365
1029
|
cullingBox: typing.Any
|
|
1366
1030
|
culled: typing.Any
|
|
1367
1031
|
color: mathutils.Vector
|
|
1368
|
-
""" The object color of the object. [r, g, b, a]
|
|
1369
|
-
|
|
1370
|
-
:type: mathutils.Vector
|
|
1371
|
-
"""
|
|
1032
|
+
""" The object color of the object. [r, g, b, a]"""
|
|
1372
1033
|
|
|
1373
1034
|
physicsCulling: bool
|
|
1374
|
-
""" True if the object suspends its physics depending on its nearest distance to any camera.
|
|
1375
|
-
|
|
1376
|
-
:type: bool
|
|
1377
|
-
"""
|
|
1035
|
+
""" True if the object suspends its physics depending on its nearest distance to any camera."""
|
|
1378
1036
|
|
|
1379
1037
|
logicCulling: bool
|
|
1380
|
-
""" True if the object suspends its logic and animation depending on its nearest distance to any camera.
|
|
1381
|
-
|
|
1382
|
-
:type: bool
|
|
1383
|
-
"""
|
|
1038
|
+
""" True if the object suspends its logic and animation depending on its nearest distance to any camera."""
|
|
1384
1039
|
|
|
1385
1040
|
physicsCullingRadius: float
|
|
1386
1041
|
""" Suspend object's physics if this radius is smaller than its nearest distance to any camera
|
|
1387
|
-
and `physicsCulling` set to True.
|
|
1388
|
-
|
|
1389
|
-
:type: float
|
|
1390
|
-
"""
|
|
1042
|
+
and `physicsCulling` set to True."""
|
|
1391
1043
|
|
|
1392
1044
|
logicCullingRadius: float
|
|
1393
1045
|
""" Suspend object's logic and animation if this radius is smaller than its nearest distance to any camera
|
|
1394
|
-
and `logicCulling` set to True.
|
|
1395
|
-
|
|
1396
|
-
:type: float
|
|
1397
|
-
"""
|
|
1046
|
+
and `logicCulling` set to True."""
|
|
1398
1047
|
|
|
1399
1048
|
occlusion: typing.Any
|
|
1400
1049
|
position: mathutils.Vector
|
|
1401
|
-
""" The object's position. [x, y, z] On write: local position, on read: world positionUse `localPosition` and `worldPosition`.0.0.1
|
|
1402
|
-
|
|
1403
|
-
:type: mathutils.Vector
|
|
1404
|
-
"""
|
|
1050
|
+
""" The object's position. [x, y, z] On write: local position, on read: world positionUse `localPosition` and `worldPosition`.0.0.1"""
|
|
1405
1051
|
|
|
1406
1052
|
orientation: mathutils.Matrix
|
|
1407
|
-
""" The object's orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector. On write: local orientation, on read: world orientationUse `localOrientation` and `worldOrientation`.0.0.1
|
|
1408
|
-
|
|
1409
|
-
:type: mathutils.Matrix
|
|
1410
|
-
"""
|
|
1053
|
+
""" The object's orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector. On write: local orientation, on read: world orientationUse `localOrientation` and `worldOrientation`.0.0.1"""
|
|
1411
1054
|
|
|
1412
1055
|
scaling: mathutils.Vector
|
|
1413
|
-
""" The object's scaling factor. [sx, sy, sz] On write: local scaling, on read: world scalingUse `localScale` and `worldScale`.0.0.1
|
|
1414
|
-
|
|
1415
|
-
:type: mathutils.Vector
|
|
1416
|
-
"""
|
|
1056
|
+
""" The object's scaling factor. [sx, sy, sz] On write: local scaling, on read: world scalingUse `localScale` and `worldScale`.0.0.1"""
|
|
1417
1057
|
|
|
1418
1058
|
localOrientation: mathutils.Matrix
|
|
1419
|
-
""" The object's local orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector.
|
|
1420
|
-
|
|
1421
|
-
:type: mathutils.Matrix
|
|
1422
|
-
"""
|
|
1059
|
+
""" The object's local orientation. 3x3 Matrix. You can also write a Quaternion or Euler vector."""
|
|
1423
1060
|
|
|
1424
1061
|
worldOrientation: mathutils.Matrix
|
|
1425
|
-
""" The object's world orientation. 3x3 Matrix.
|
|
1426
|
-
|
|
1427
|
-
:type: mathutils.Matrix
|
|
1428
|
-
"""
|
|
1062
|
+
""" The object's world orientation. 3x3 Matrix."""
|
|
1429
1063
|
|
|
1430
1064
|
localScale: mathutils.Vector
|
|
1431
|
-
""" The object's local scaling factor. [sx, sy, sz]
|
|
1432
|
-
|
|
1433
|
-
:type: mathutils.Vector
|
|
1434
|
-
"""
|
|
1065
|
+
""" The object's local scaling factor. [sx, sy, sz]"""
|
|
1435
1066
|
|
|
1436
1067
|
worldScale: mathutils.Vector
|
|
1437
|
-
""" The object's world scaling factor. [sx, sy, sz]
|
|
1438
|
-
|
|
1439
|
-
:type: mathutils.Vector
|
|
1440
|
-
"""
|
|
1068
|
+
""" The object's world scaling factor. [sx, sy, sz]"""
|
|
1441
1069
|
|
|
1442
1070
|
localPosition: mathutils.Vector
|
|
1443
|
-
""" The object's local position. [x, y, z]
|
|
1444
|
-
|
|
1445
|
-
:type: mathutils.Vector
|
|
1446
|
-
"""
|
|
1071
|
+
""" The object's local position. [x, y, z]"""
|
|
1447
1072
|
|
|
1448
1073
|
worldPosition: mathutils.Vector
|
|
1449
|
-
""" The object's world position. [x, y, z]
|
|
1450
|
-
|
|
1451
|
-
:type: mathutils.Vector
|
|
1452
|
-
"""
|
|
1074
|
+
""" The object's world position. [x, y, z]"""
|
|
1453
1075
|
|
|
1454
1076
|
localTransform: mathutils.Matrix
|
|
1455
|
-
""" The object's local space transform matrix. 4x4 Matrix.
|
|
1456
|
-
|
|
1457
|
-
:type: mathutils.Matrix
|
|
1458
|
-
"""
|
|
1077
|
+
""" The object's local space transform matrix. 4x4 Matrix."""
|
|
1459
1078
|
|
|
1460
1079
|
worldTransform: mathutils.Matrix
|
|
1461
|
-
""" The object's world space transform matrix. 4x4 Matrix.
|
|
1462
|
-
|
|
1463
|
-
:type: mathutils.Matrix
|
|
1464
|
-
"""
|
|
1080
|
+
""" The object's world space transform matrix. 4x4 Matrix."""
|
|
1465
1081
|
|
|
1466
1082
|
localLinearVelocity: mathutils.Vector
|
|
1467
|
-
""" The object's local linear velocity. [x, y, z]
|
|
1468
|
-
|
|
1469
|
-
:type: mathutils.Vector
|
|
1470
|
-
"""
|
|
1083
|
+
""" The object's local linear velocity. [x, y, z]"""
|
|
1471
1084
|
|
|
1472
1085
|
worldLinearVelocity: mathutils.Vector
|
|
1473
|
-
""" The object's world linear velocity. [x, y, z]
|
|
1474
|
-
|
|
1475
|
-
:type: mathutils.Vector
|
|
1476
|
-
"""
|
|
1086
|
+
""" The object's world linear velocity. [x, y, z]"""
|
|
1477
1087
|
|
|
1478
1088
|
localAngularVelocity: mathutils.Vector
|
|
1479
|
-
""" The object's local angular velocity. [x, y, z]
|
|
1480
|
-
|
|
1481
|
-
:type: mathutils.Vector
|
|
1482
|
-
"""
|
|
1089
|
+
""" The object's local angular velocity. [x, y, z]"""
|
|
1483
1090
|
|
|
1484
1091
|
worldAngularVelocity: mathutils.Vector
|
|
1485
|
-
""" The object's world angular velocity. [x, y, z]
|
|
1486
|
-
|
|
1487
|
-
:type: mathutils.Vector
|
|
1488
|
-
"""
|
|
1092
|
+
""" The object's world angular velocity. [x, y, z]"""
|
|
1489
1093
|
|
|
1490
1094
|
gravity: mathutils.Vector
|
|
1491
|
-
""" The object's gravity. [x, y, z]
|
|
1492
|
-
|
|
1493
|
-
:type: mathutils.Vector
|
|
1494
|
-
"""
|
|
1095
|
+
""" The object's gravity. [x, y, z]"""
|
|
1495
1096
|
|
|
1496
1097
|
timeOffset: float
|
|
1497
|
-
""" adjust the slowparent delay at runtime.
|
|
1498
|
-
|
|
1499
|
-
:type: float
|
|
1500
|
-
"""
|
|
1098
|
+
""" adjust the slowparent delay at runtime."""
|
|
1501
1099
|
|
|
1502
1100
|
blenderObject: typing.Any
|
|
1503
1101
|
""" This KX_GameObject's Object."""
|
|
1504
1102
|
|
|
1505
1103
|
state: int
|
|
1506
|
-
""" the game object's state bitmask, using the first 30 bits, one bit must always be set.
|
|
1507
|
-
|
|
1508
|
-
:type: int
|
|
1509
|
-
"""
|
|
1104
|
+
""" the game object's state bitmask, using the first 30 bits, one bit must always be set."""
|
|
1510
1105
|
|
|
1511
1106
|
meshes: typing.Any
|
|
1512
1107
|
""" a list meshes for this object."""
|
|
1513
1108
|
|
|
1514
1109
|
batchGroup: typing.Any
|
|
1515
1110
|
sensors: list
|
|
1516
|
-
""" a sequence of `~bge.types.SCA_ISensor` objects with string/index lookups and iterator support.
|
|
1517
|
-
|
|
1518
|
-
:type: list
|
|
1519
|
-
"""
|
|
1111
|
+
""" a sequence of `~bge.types.SCA_ISensor` objects with string/index lookups and iterator support."""
|
|
1520
1112
|
|
|
1521
1113
|
controllers: typing.Any
|
|
1522
1114
|
""" a sequence of `~bge.types.SCA_IController` objects with string/index lookups and iterator support."""
|
|
1523
1115
|
|
|
1524
1116
|
actuators: list
|
|
1525
|
-
""" a list of `~bge.types.SCA_IActuator` with string/index lookups and iterator support.
|
|
1526
|
-
|
|
1527
|
-
:type: list
|
|
1528
|
-
"""
|
|
1117
|
+
""" a list of `~bge.types.SCA_IActuator` with string/index lookups and iterator support."""
|
|
1529
1118
|
|
|
1530
1119
|
attrDict: dict
|
|
1531
|
-
""" get the objects internal python attribute dictionary for direct (faster) access.
|
|
1532
|
-
|
|
1533
|
-
:type: dict
|
|
1534
|
-
"""
|
|
1120
|
+
""" get the objects internal python attribute dictionary for direct (faster) access."""
|
|
1535
1121
|
|
|
1536
1122
|
components: typing.Any
|
|
1537
1123
|
""" All python components."""
|
|
@@ -1543,28 +1129,16 @@ and `logicCulling` set to True.
|
|
|
1543
1129
|
""" all children of this object including children's children, (read-only)."""
|
|
1544
1130
|
|
|
1545
1131
|
life: float
|
|
1546
|
-
""" The number of frames until the object ends, assumes one frame is 1/60 second (read-only).
|
|
1547
|
-
|
|
1548
|
-
:type: float
|
|
1549
|
-
"""
|
|
1132
|
+
""" The number of frames until the object ends, assumes one frame is 1/60 second (read-only)."""
|
|
1550
1133
|
|
|
1551
1134
|
debug: bool
|
|
1552
|
-
""" If true, the object's debug properties will be displayed on screen.
|
|
1553
|
-
|
|
1554
|
-
:type: bool
|
|
1555
|
-
"""
|
|
1135
|
+
""" If true, the object's debug properties will be displayed on screen."""
|
|
1556
1136
|
|
|
1557
1137
|
debugRecursive: bool
|
|
1558
|
-
""" If true, the object's and children's debug properties will be displayed on screen.
|
|
1559
|
-
|
|
1560
|
-
:type: bool
|
|
1561
|
-
"""
|
|
1138
|
+
""" If true, the object's and children's debug properties will be displayed on screen."""
|
|
1562
1139
|
|
|
1563
1140
|
currentLodLevel: int
|
|
1564
|
-
""" The index of the level of detail (LOD) currently used by this object (read-only).
|
|
1565
|
-
|
|
1566
|
-
:type: int
|
|
1567
|
-
"""
|
|
1141
|
+
""" The index of the level of detail (LOD) currently used by this object (read-only)."""
|
|
1568
1142
|
|
|
1569
1143
|
lodManager: typing.Any
|
|
1570
1144
|
""" Return the lod manager of this object.
|
|
@@ -1573,47 +1147,36 @@ The lod manager is shared between instance objects and can be changed to use the
|
|
|
1573
1147
|
If the lod manager is set to None the object's mesh backs to the mesh of the previous first lod level."""
|
|
1574
1148
|
|
|
1575
1149
|
onRemove: list
|
|
1576
|
-
""" A list of callables to run when the KX_GameObject is destroyed.or
|
|
1577
|
-
|
|
1578
|
-
:type: list
|
|
1579
|
-
"""
|
|
1150
|
+
""" A list of callables to run when the KX_GameObject is destroyed.or"""
|
|
1580
1151
|
|
|
1581
1152
|
logger: typing.Any
|
|
1582
1153
|
""" A logger instance that can be used to log messages related to this object (read-only)."""
|
|
1583
1154
|
|
|
1584
1155
|
loggerName: str
|
|
1585
1156
|
""" A name used to create the logger instance. By default, it takes the form Type[Name]
|
|
1586
|
-
and can be optionally overridden as below:
|
|
1587
|
-
|
|
1588
|
-
:type: str
|
|
1589
|
-
"""
|
|
1157
|
+
and can be optionally overridden as below:"""
|
|
1590
1158
|
|
|
1591
|
-
def endObject(self):
|
|
1159
|
+
def endObject(self) -> None:
|
|
1592
1160
|
"""Delete this object, can be used in place of the EndObject Actuator.The actual removal of the object from the scene is delayed."""
|
|
1593
1161
|
|
|
1594
1162
|
def replaceMesh(
|
|
1595
1163
|
self, mesh: str, useDisplayMesh: bool = True, usePhysicsMesh: bool = False
|
|
1596
|
-
):
|
|
1164
|
+
) -> None:
|
|
1597
1165
|
"""Replace the mesh of this object with a new mesh. This works the same was as the actuator.
|
|
1598
1166
|
|
|
1599
1167
|
:param mesh: mesh to replace or the meshes name.
|
|
1600
|
-
:type mesh: str
|
|
1601
1168
|
:param useDisplayMesh: when enabled the display mesh will be replaced (optional argument).
|
|
1602
|
-
:type useDisplayMesh: bool
|
|
1603
1169
|
:param usePhysicsMesh: when enabled the physics mesh will be replaced (optional argument).
|
|
1604
|
-
:type usePhysicsMesh: bool
|
|
1605
1170
|
"""
|
|
1606
1171
|
|
|
1607
|
-
def setVisible(self, visible: bool, recursive: bool | None = False):
|
|
1608
|
-
"""Sets the game
|
|
1172
|
+
def setVisible(self, visible: bool, recursive: bool | None = False) -> None:
|
|
1173
|
+
"""Sets the game objects visible flag.
|
|
1609
1174
|
|
|
1610
1175
|
:param visible: the visible state to set.
|
|
1611
|
-
:type visible: bool
|
|
1612
1176
|
:param recursive: optional argument to set all childrens visibility flag too, defaults to False if no value passed.
|
|
1613
|
-
:type recursive: bool | None
|
|
1614
1177
|
"""
|
|
1615
1178
|
|
|
1616
|
-
def setOcclusion(self, occlusion, recursive):
|
|
1179
|
+
def setOcclusion(self, occlusion, recursive) -> None:
|
|
1617
1180
|
"""
|
|
1618
1181
|
|
|
1619
1182
|
:param occlusion:
|
|
@@ -1625,11 +1188,10 @@ and can be optionally overridden as below:
|
|
|
1625
1188
|
vect: collections.abc.Sequence[float] | mathutils.Vector,
|
|
1626
1189
|
axis: int = 2,
|
|
1627
1190
|
factor: float = 1.0,
|
|
1628
|
-
):
|
|
1629
|
-
"""Aligns any of the game
|
|
1191
|
+
) -> None:
|
|
1192
|
+
"""Aligns any of the game objects axis along the given vector.
|
|
1630
1193
|
|
|
1631
1194
|
:param vect: a vector to align the axis.
|
|
1632
|
-
:type vect: collections.abc.Sequence[float] | mathutils.Vector
|
|
1633
1195
|
:param axis: The axis you want to align
|
|
1634
1196
|
|
|
1635
1197
|
0: X axis
|
|
@@ -1637,27 +1199,25 @@ and can be optionally overridden as below:
|
|
|
1637
1199
|
1: Y axis
|
|
1638
1200
|
|
|
1639
1201
|
2: Z axis
|
|
1640
|
-
:type axis: int
|
|
1641
1202
|
:param factor: Only rotate a fraction of the distance to the target vector (0.0 - 1.0)
|
|
1642
|
-
:type factor: float
|
|
1643
1203
|
"""
|
|
1644
1204
|
|
|
1645
|
-
def getAxisVect(
|
|
1646
|
-
|
|
1205
|
+
def getAxisVect(
|
|
1206
|
+
self, vect: collections.abc.Sequence[float] | mathutils.Vector
|
|
1207
|
+
) -> None:
|
|
1208
|
+
"""Returns the axis vector rotates by the objects worldspace orientation.
|
|
1647
1209
|
This is the equivalent of multiplying the vector by the orientation matrix.
|
|
1648
1210
|
|
|
1649
1211
|
:param vect: a vector to align the axis.
|
|
1650
|
-
:type vect: collections.abc.Sequence[float] | mathutils.Vector
|
|
1651
1212
|
:return: The vector in relation to the objects rotation.
|
|
1652
1213
|
"""
|
|
1653
1214
|
|
|
1654
1215
|
def applyMovement(
|
|
1655
1216
|
self, movement: collections.abc.Sequence[float] | mathutils.Vector, local
|
|
1656
|
-
):
|
|
1657
|
-
"""Sets the game
|
|
1217
|
+
) -> None:
|
|
1218
|
+
"""Sets the game objects movement.
|
|
1658
1219
|
|
|
1659
1220
|
:param movement: movement vector.
|
|
1660
|
-
:type movement: collections.abc.Sequence[float] | mathutils.Vector
|
|
1661
1221
|
:param local: False: you get the "global" movement ie: relative to world orientation.
|
|
1662
1222
|
|
|
1663
1223
|
True: you get the "local" movement ie: relative to object orientation.
|
|
@@ -1667,11 +1227,10 @@ and can be optionally overridden as below:
|
|
|
1667
1227
|
|
|
1668
1228
|
def applyRotation(
|
|
1669
1229
|
self, rotation: collections.abc.Sequence[float] | mathutils.Vector, local
|
|
1670
|
-
):
|
|
1671
|
-
"""Sets the game
|
|
1230
|
+
) -> None:
|
|
1231
|
+
"""Sets the game objects rotation.
|
|
1672
1232
|
|
|
1673
1233
|
:param rotation: rotation vector.
|
|
1674
|
-
:type rotation: collections.abc.Sequence[float] | mathutils.Vector
|
|
1675
1234
|
:param local: False: you get the "global" rotation ie: relative to world orientation.
|
|
1676
1235
|
|
|
1677
1236
|
True: you get the "local" rotation ie: relative to object orientation.
|
|
@@ -1681,79 +1240,70 @@ and can be optionally overridden as below:
|
|
|
1681
1240
|
|
|
1682
1241
|
def applyForce(
|
|
1683
1242
|
self, force: collections.abc.Sequence[float] | mathutils.Vector, local: bool
|
|
1684
|
-
):
|
|
1685
|
-
"""Sets the game
|
|
1243
|
+
) -> None:
|
|
1244
|
+
"""Sets the game objects force.This requires a dynamic object.
|
|
1686
1245
|
|
|
1687
1246
|
:param force: force vector.
|
|
1688
|
-
:type force: collections.abc.Sequence[float] | mathutils.Vector
|
|
1689
1247
|
:param local: False: you get the "global" force ie: relative to world orientation.
|
|
1690
1248
|
|
|
1691
1249
|
True: you get the "local" force ie: relative to object orientation.
|
|
1692
1250
|
|
|
1693
1251
|
Default to False if not passed.
|
|
1694
|
-
:type local: bool
|
|
1695
1252
|
"""
|
|
1696
1253
|
|
|
1697
1254
|
def applyTorque(
|
|
1698
1255
|
self, torque: collections.abc.Sequence[float] | mathutils.Vector, local: bool
|
|
1699
|
-
):
|
|
1700
|
-
"""Sets the game
|
|
1256
|
+
) -> None:
|
|
1257
|
+
"""Sets the game objects torque.This requires a dynamic object.
|
|
1701
1258
|
|
|
1702
1259
|
:param torque: torque vector.
|
|
1703
|
-
:type torque: collections.abc.Sequence[float] | mathutils.Vector
|
|
1704
1260
|
:param local: False: you get the "global" torque ie: relative to world orientation.
|
|
1705
1261
|
|
|
1706
1262
|
True: you get the "local" torque ie: relative to object orientation.
|
|
1707
1263
|
|
|
1708
1264
|
Default to False if not passed.
|
|
1709
|
-
:type local: bool
|
|
1710
1265
|
"""
|
|
1711
1266
|
|
|
1712
|
-
def getLinearVelocity(self, local: bool):
|
|
1713
|
-
"""Gets the game
|
|
1267
|
+
def getLinearVelocity(self, local: bool) -> None:
|
|
1268
|
+
"""Gets the game objects linear velocity.This method returns the game objects velocity through its center of mass, ie no angular velocity component.
|
|
1714
1269
|
|
|
1715
1270
|
:param local: False: you get the "global" velocity ie: relative to world orientation.
|
|
1716
1271
|
|
|
1717
1272
|
True: you get the "local" velocity ie: relative to object orientation.
|
|
1718
1273
|
|
|
1719
1274
|
Default to False if not passed.
|
|
1720
|
-
:
|
|
1721
|
-
:return: the object's linear velocity.
|
|
1275
|
+
:return: the objects linear velocity.
|
|
1722
1276
|
"""
|
|
1723
1277
|
|
|
1724
1278
|
def setLinearVelocity(
|
|
1725
1279
|
self, velocity: collections.abc.Sequence[float] | mathutils.Vector, local: bool
|
|
1726
|
-
):
|
|
1727
|
-
"""Sets the game
|
|
1280
|
+
) -> None:
|
|
1281
|
+
"""Sets the game objects linear velocity.This method sets game objects velocity through its center of mass,
|
|
1728
1282
|
ie no angular velocity component.This requires a dynamic object.
|
|
1729
1283
|
|
|
1730
1284
|
:param velocity: linear velocity vector.
|
|
1731
|
-
:type velocity: collections.abc.Sequence[float] | mathutils.Vector
|
|
1732
1285
|
:param local: False: you get the "global" velocity ie: relative to world orientation.
|
|
1733
1286
|
|
|
1734
1287
|
True: you get the "local" velocity ie: relative to object orientation.
|
|
1735
1288
|
|
|
1736
1289
|
Default to False if not passed.
|
|
1737
|
-
:type local: bool
|
|
1738
1290
|
"""
|
|
1739
1291
|
|
|
1740
|
-
def getAngularVelocity(self, local: bool):
|
|
1741
|
-
"""Gets the game
|
|
1292
|
+
def getAngularVelocity(self, local: bool) -> None:
|
|
1293
|
+
"""Gets the game objects angular velocity.
|
|
1742
1294
|
|
|
1743
1295
|
:param local: False: you get the "global" velocity ie: relative to world orientation.
|
|
1744
1296
|
|
|
1745
1297
|
True: you get the "local" velocity ie: relative to object orientation.
|
|
1746
1298
|
|
|
1747
1299
|
Default to False if not passed.
|
|
1748
|
-
:
|
|
1749
|
-
:return: the object's angular velocity.
|
|
1300
|
+
:return: the objects angular velocity.
|
|
1750
1301
|
"""
|
|
1751
1302
|
|
|
1752
|
-
def setAngularVelocity(self, velocity: bool, local):
|
|
1753
|
-
"""Sets the game
|
|
1303
|
+
def setAngularVelocity(self, velocity: bool, local) -> None:
|
|
1304
|
+
"""Sets the game objects angular velocity.This requires a dynamic object.
|
|
1754
1305
|
|
|
1755
1306
|
:param velocity: angular velocity vector.
|
|
1756
|
-
:type velocity: bool
|
|
1757
1307
|
:param local: False: you get the "global" velocity ie: relative to world orientation.
|
|
1758
1308
|
|
|
1759
1309
|
True: you get the "local" velocity ie: relative to object orientation.
|
|
@@ -1763,86 +1313,81 @@ and can be optionally overridden as below:
|
|
|
1763
1313
|
|
|
1764
1314
|
def getVelocity(
|
|
1765
1315
|
self, point: collections.abc.Sequence[float] | mathutils.Vector | None = []
|
|
1766
|
-
):
|
|
1767
|
-
"""Gets the game
|
|
1316
|
+
) -> None:
|
|
1317
|
+
"""Gets the game objects velocity at the specified point.Gets the game objects velocity at the specified point, including angular
|
|
1768
1318
|
components.
|
|
1769
1319
|
|
|
1770
1320
|
:param point: optional point to return the velocity for, in local coordinates, defaults to (0, 0, 0) if no value passed.
|
|
1771
|
-
:type point: collections.abc.Sequence[float] | mathutils.Vector | None
|
|
1772
1321
|
:return: the velocity at the specified point.
|
|
1773
1322
|
"""
|
|
1774
1323
|
|
|
1775
|
-
def getReactionForce(self): ...
|
|
1324
|
+
def getReactionForce(self) -> None: ...
|
|
1776
1325
|
def applyImpulse(
|
|
1777
1326
|
self,
|
|
1778
1327
|
point,
|
|
1779
1328
|
impulse: collections.abc.Sequence[float] | mathutils.Vector,
|
|
1780
1329
|
local: bool,
|
|
1781
|
-
):
|
|
1330
|
+
) -> None:
|
|
1782
1331
|
"""Applies an impulse to the game object.This will apply the specified impulse to the game object at the specified point.
|
|
1783
|
-
If point != position, applyImpulse will also change the
|
|
1332
|
+
If point != position, applyImpulse will also change the objects angular momentum.
|
|
1784
1333
|
Otherwise, only linear momentum will change.
|
|
1785
1334
|
|
|
1786
1335
|
:param point: the point to apply the impulse to (in world or local coordinates)
|
|
1787
1336
|
:param impulse: impulse vector.
|
|
1788
|
-
:type impulse: collections.abc.Sequence[float] | mathutils.Vector
|
|
1789
1337
|
:param local: False: you get the "global" impulse ie: relative to world coordinates with world orientation.
|
|
1790
1338
|
|
|
1791
1339
|
True: you get the "local" impulse ie: relative to local coordinates with object orientation.
|
|
1792
1340
|
|
|
1793
1341
|
Default to False if not passed.
|
|
1794
|
-
:type local: bool
|
|
1795
1342
|
"""
|
|
1796
1343
|
|
|
1797
|
-
def setDamping(self, linear_damping, angular_damping):
|
|
1344
|
+
def setDamping(self, linear_damping, angular_damping) -> None:
|
|
1798
1345
|
"""Sets both the `linearDamping` and `angularDamping` simultaneously. This is more efficient than setting both properties individually.
|
|
1799
1346
|
|
|
1800
1347
|
:param linear_damping: Linear ("translational") damping factor.
|
|
1801
1348
|
:param angular_damping: Angular ("rotational") damping factor.
|
|
1802
1349
|
"""
|
|
1803
1350
|
|
|
1804
|
-
def suspendPhysics(self, freeConstraints: bool):
|
|
1351
|
+
def suspendPhysics(self, freeConstraints: bool) -> None:
|
|
1805
1352
|
"""Suspends physics for this object.
|
|
1806
1353
|
|
|
1807
1354
|
:param freeConstraints: When set to True physics constraints used by the object are deleted.
|
|
1808
1355
|
Else when False (the default) constraints are restored when restoring physics.
|
|
1809
|
-
:type freeConstraints: bool
|
|
1810
1356
|
"""
|
|
1811
1357
|
|
|
1812
|
-
def restorePhysics(self):
|
|
1358
|
+
def restorePhysics(self) -> None:
|
|
1813
1359
|
"""Resumes physics for this object. Also reinstates collisions."""
|
|
1814
1360
|
|
|
1815
|
-
def suspendDynamics(self, ghost: bool):
|
|
1361
|
+
def suspendDynamics(self, ghost: bool) -> None:
|
|
1816
1362
|
"""Suspends dynamics physics for this object.:py:attr:`isSuspendDynamics` allows you to inspect whether the object is in a suspended state.
|
|
1817
1363
|
|
|
1818
1364
|
:param ghost: When set to True, collisions with the object will be ignored, similar to the "ghost" checkbox in
|
|
1819
1365
|
Blender. When False (the default), the object becomes static but still collide with other objects.
|
|
1820
|
-
:type ghost: bool
|
|
1821
1366
|
"""
|
|
1822
1367
|
|
|
1823
|
-
def restoreDynamics(self):
|
|
1368
|
+
def restoreDynamics(self) -> None:
|
|
1824
1369
|
"""Resumes dynamics physics for this object. Also reinstates collisions; the object will no longer be a ghost."""
|
|
1825
1370
|
|
|
1826
|
-
def enableRigidBody(self):
|
|
1371
|
+
def enableRigidBody(self) -> None:
|
|
1827
1372
|
"""Enables rigid body physics for this object.Rigid body physics allows the object to roll on collisions."""
|
|
1828
1373
|
|
|
1829
|
-
def disableRigidBody(self):
|
|
1374
|
+
def disableRigidBody(self) -> None:
|
|
1830
1375
|
"""Disables rigid body physics for this object."""
|
|
1831
1376
|
|
|
1832
|
-
def setCcdMotionThreshold(self, ccd_motion_threshold):
|
|
1377
|
+
def setCcdMotionThreshold(self, ccd_motion_threshold) -> None:
|
|
1833
1378
|
"""Sets `ccdMotionThreshold` that is the delta of movement that has to happen in one physics tick to trigger the continuous motion detection.
|
|
1834
1379
|
|
|
1835
1380
|
:param ccd_motion_threshold: delta of movement.
|
|
1836
1381
|
"""
|
|
1837
1382
|
|
|
1838
|
-
def setCcdSweptSphereRadius(self, ccd_swept_sphere_radius):
|
|
1383
|
+
def setCcdSweptSphereRadius(self, ccd_swept_sphere_radius) -> None:
|
|
1839
1384
|
"""Sets `ccdSweptSphereRadius` that is the radius of the sphere that is used to check for possible collisions when ccd is activated.
|
|
1840
1385
|
|
|
1841
1386
|
:param ccd_swept_sphere_radius: sphere radius.
|
|
1842
1387
|
"""
|
|
1843
1388
|
|
|
1844
|
-
def setParent(self, parent, compound: bool = True, ghost: bool = True):
|
|
1845
|
-
"""Sets this
|
|
1389
|
+
def setParent(self, parent, compound: bool = True, ghost: bool = True) -> None:
|
|
1390
|
+
"""Sets this objects parent.
|
|
1846
1391
|
Control the shape status with the optional compound and ghost parameters:In that case you can control if it should be ghost or not:
|
|
1847
1392
|
|
|
1848
1393
|
:param parent: new parent object.
|
|
@@ -1851,26 +1396,23 @@ and can be optionally overridden as below:
|
|
|
1851
1396
|
True: the object shape should be added to the parent compound shape.
|
|
1852
1397
|
|
|
1853
1398
|
False: the object should keep its individual shape.
|
|
1854
|
-
:type compound: bool
|
|
1855
1399
|
:param ghost: whether the object should be ghost while parented.
|
|
1856
1400
|
|
|
1857
1401
|
True: if the object should be made ghost while parented.
|
|
1858
1402
|
|
|
1859
1403
|
False: if the object should be solid while parented.
|
|
1860
|
-
:type ghost: bool
|
|
1861
1404
|
"""
|
|
1862
1405
|
|
|
1863
|
-
def removeParent(self):
|
|
1406
|
+
def removeParent(self) -> None:
|
|
1864
1407
|
"""Removes this objects parent."""
|
|
1865
1408
|
|
|
1866
|
-
def getPhysicsId(self):
|
|
1867
|
-
"""Returns the user data object associated with this game
|
|
1409
|
+
def getPhysicsId(self) -> None:
|
|
1410
|
+
"""Returns the user data object associated with this game objects physics controller."""
|
|
1868
1411
|
|
|
1869
1412
|
def getPropertyNames(self) -> list:
|
|
1870
1413
|
"""Gets a list of all property names.
|
|
1871
1414
|
|
|
1872
1415
|
:return: All property names for this object.
|
|
1873
|
-
:rtype: list
|
|
1874
1416
|
"""
|
|
1875
1417
|
|
|
1876
1418
|
def getDistanceTo(self, other) -> float:
|
|
@@ -1878,10 +1420,9 @@ and can be optionally overridden as below:
|
|
|
1878
1420
|
|
|
1879
1421
|
:param other: a point or another `~bge.types.KX_GameObject` to measure the distance to.
|
|
1880
1422
|
:return: distance to another object or point.
|
|
1881
|
-
:rtype: float
|
|
1882
1423
|
"""
|
|
1883
1424
|
|
|
1884
|
-
def getVectTo(self, other):
|
|
1425
|
+
def getVectTo(self, other) -> None:
|
|
1885
1426
|
"""Returns the vector and the distance to another object or point.
|
|
1886
1427
|
The vector is normalized unless the distance is 0, in which a zero length vector is returned.
|
|
1887
1428
|
|
|
@@ -1889,16 +1430,14 @@ and can be optionally overridden as below:
|
|
|
1889
1430
|
:return: (distance, globalVector(3), localVector(3))
|
|
1890
1431
|
"""
|
|
1891
1432
|
|
|
1892
|
-
def rayCastTo(self, other, dist: float = 0, prop: str = ""):
|
|
1433
|
+
def rayCastTo(self, other, dist: float = 0, prop: str = "") -> None:
|
|
1893
1434
|
"""Look towards another point/object and find first object hit within dist that matches prop.The ray is always casted from the center of the object, ignoring the object itself.
|
|
1894
1435
|
The ray is casted towards the center of another object or an explicit [x, y, z] point.
|
|
1895
1436
|
Use rayCast() if you need to retrieve the hit point
|
|
1896
1437
|
|
|
1897
1438
|
:param other: [x, y, z] or object towards which the ray is casted
|
|
1898
1439
|
:param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to other
|
|
1899
|
-
:type dist: float
|
|
1900
1440
|
:param prop: property name that object must have; can be omitted => detect any object
|
|
1901
|
-
:type prop: str
|
|
1902
1441
|
:return: the first object hit or None if no object or object does not match prop
|
|
1903
1442
|
"""
|
|
1904
1443
|
|
|
@@ -1912,7 +1451,7 @@ and can be optionally overridden as below:
|
|
|
1912
1451
|
xray: int = False,
|
|
1913
1452
|
poly: int = 0,
|
|
1914
1453
|
mask=65535,
|
|
1915
|
-
):
|
|
1454
|
+
) -> None:
|
|
1916
1455
|
"""Look from a point/object to another point/object and find first object hit within dist that matches prop.
|
|
1917
1456
|
if poly is 0, returns a 3-tuple with object reference, hit point and hit normal or (None, None, None) if no hit.
|
|
1918
1457
|
if poly is 1, returns a 4-tuple with in addition a `~bge.types.KX_PolyProxy` as 4th element.
|
|
@@ -1923,22 +1462,17 @@ and can be optionally overridden as below:
|
|
|
1923
1462
|
:param objto: [x, y, z] or object to which the ray is casted
|
|
1924
1463
|
:param objfrom: [x, y, z] or object from which the ray is casted; None or omitted => use self object center
|
|
1925
1464
|
:param dist: max distance to look (can be negative => look behind); 0 or omitted => detect up to to
|
|
1926
|
-
:type dist: float
|
|
1927
1465
|
:param prop: property name that object must have; can be omitted or "" => detect any object
|
|
1928
|
-
:type prop: str
|
|
1929
1466
|
:param face: normal option: 1=>return face normal; 0 or omitted => normal is oriented towards origin
|
|
1930
|
-
:
|
|
1931
|
-
:param xray: X-ray option: 1=>skip objects that don't match prop; 0 or omitted => stop on first object
|
|
1932
|
-
:type xray: int
|
|
1467
|
+
:param xray: X-ray option: 1=>skip objects that dont match prop; 0 or omitted => stop on first object
|
|
1933
1468
|
:param poly: polygon option: 0, 1 or 2 to return a 3-, 4- or 5-tuple with information on the face hit.
|
|
1934
1469
|
|
|
1935
1470
|
0 or omitted: return value is a 3-tuple (object, hitpoint, hitnormal) or (None, None, None) if no hit
|
|
1936
1471
|
|
|
1937
|
-
1: return value is a 4-tuple and the 4th element is a `~bge.types.KX_PolyProxy` or None if no hit or the object
|
|
1472
|
+
1: return value is a 4-tuple and the 4th element is a `~bge.types.KX_PolyProxy` or None if no hit or the object doesnt use a mesh collision shape.
|
|
1938
1473
|
|
|
1939
|
-
2: return value is a 5-tuple and the 5th element is a 2-tuple (u, v) with the UV mapping of the hit point or None if no hit, or the object
|
|
1940
|
-
:
|
|
1941
|
-
:param mask: collision mask: The collision mask (16 layers mapped to a 16-bit integer) is combined with each object's collision group, to hit only a subset of the objects in the scene. Only those objects for which collisionGroup & mask is true can be hit.
|
|
1474
|
+
2: return value is a 5-tuple and the 5th element is a 2-tuple (u, v) with the UV mapping of the hit point or None if no hit, or the object doesnt use a mesh collision shape, or doesnt have a UV mapping.
|
|
1475
|
+
:param mask: collision mask: The collision mask (16 layers mapped to a 16-bit integer) is combined with each objects collision group, to hit only a subset of the objects in the scene. Only those objects for which collisionGroup & mask is true can be hit.
|
|
1942
1476
|
:return: (object, hitpoint, hitnormal) or (object, hitpoint, hitnormal, polygon) or (object, hitpoint, hitnormal, polygon, hituv).
|
|
1943
1477
|
|
|
1944
1478
|
object, hitpoint and hitnormal are None if no hit.
|
|
@@ -1954,31 +1488,25 @@ and can be optionally overridden as below:
|
|
|
1954
1488
|
"""Test if this object collides object `obj`.
|
|
1955
1489
|
|
|
1956
1490
|
:param obj: the object to test collision with
|
|
1957
|
-
:type obj: str | typing_extensions.Self
|
|
1958
1491
|
:return: (collide, points)
|
|
1959
1492
|
|
|
1960
1493
|
collide, True if this object collides object `obj`
|
|
1961
1494
|
|
|
1962
1495
|
points, contact point data of the collision or None
|
|
1963
|
-
:rtype: list[KX_CollisionContactPoint]
|
|
1964
1496
|
"""
|
|
1965
1497
|
|
|
1966
|
-
def setCollisionMargin(self, margin: float):
|
|
1498
|
+
def setCollisionMargin(self, margin: float) -> None:
|
|
1967
1499
|
"""Set the objects collision margin.
|
|
1968
1500
|
|
|
1969
1501
|
:param margin: the collision margin distance in blender units.
|
|
1970
|
-
:type margin: float
|
|
1971
1502
|
"""
|
|
1972
1503
|
|
|
1973
|
-
def sendMessage(self, subject: str, body: str = "", to: str = ""):
|
|
1504
|
+
def sendMessage(self, subject: str, body: str = "", to: str = "") -> None:
|
|
1974
1505
|
"""Sends a message.
|
|
1975
1506
|
|
|
1976
1507
|
:param subject: The subject of the message
|
|
1977
|
-
:type subject: str
|
|
1978
1508
|
:param body: The body of the message (optional)
|
|
1979
|
-
:type body: str
|
|
1980
1509
|
:param to: The name of the object to send the message to (optional)
|
|
1981
|
-
:type to: str
|
|
1982
1510
|
"""
|
|
1983
1511
|
|
|
1984
1512
|
def reinstancePhysicsMesh(
|
|
@@ -1991,31 +1519,24 @@ and can be optionally overridden as below:
|
|
|
1991
1519
|
"""Updates the physics system with the changed mesh.If no arguments are given the physics mesh will be re-created from the first mesh assigned to the game object.
|
|
1992
1520
|
|
|
1993
1521
|
:param gameObject: optional argument, set the physics shape from this gameObjets mesh.
|
|
1994
|
-
:type gameObject: str | None
|
|
1995
1522
|
:param meshObject: optional argument, set the physics shape from this mesh.
|
|
1996
|
-
:type meshObject: str | None
|
|
1997
1523
|
:param dupli: optional argument, duplicate the physics shape.
|
|
1998
|
-
:type dupli: bool | None
|
|
1999
1524
|
:param evaluated: optional argument, use evaluated object physics shape (Object with modifiers applied).
|
|
2000
|
-
:type evaluated: bool | None
|
|
2001
1525
|
:return: True if reinstance succeeded, False if it failed.
|
|
2002
|
-
:rtype: bool
|
|
2003
1526
|
"""
|
|
2004
1527
|
|
|
2005
1528
|
def replacePhysicsShape(self, gameObject: str) -> bool:
|
|
2006
1529
|
"""Replace the current physics shape.
|
|
2007
1530
|
|
|
2008
1531
|
:param gameObject: set the physics shape from this gameObjets.
|
|
2009
|
-
:type gameObject: str
|
|
2010
1532
|
:return: True if replace succeeded, False if it failed.
|
|
2011
|
-
:rtype: bool
|
|
2012
1533
|
"""
|
|
2013
1534
|
|
|
2014
|
-
def get(self, key, default):
|
|
1535
|
+
def get(self, key, default) -> None:
|
|
2015
1536
|
"""Return the value matching key, or the default value if its not found.
|
|
2016
1537
|
:arg key: the matching key
|
|
2017
1538
|
:type key: string
|
|
2018
|
-
:arg default: optional default value is the key
|
|
1539
|
+
:arg default: optional default value is the key isnt matching, defaults to None if no value passed.
|
|
2019
1540
|
:return: The key value or a default.
|
|
2020
1541
|
|
|
2021
1542
|
:param key:
|
|
@@ -2035,114 +1556,80 @@ and can be optionally overridden as below:
|
|
|
2035
1556
|
ipo_flags=0,
|
|
2036
1557
|
speed: float = 1.0,
|
|
2037
1558
|
blend_mode: int = KX_ACTION_BLEND_BLEND,
|
|
2038
|
-
):
|
|
1559
|
+
) -> None:
|
|
2039
1560
|
"""Plays an action.
|
|
2040
1561
|
|
|
2041
1562
|
:param name: the name of the action.
|
|
2042
|
-
:type name: str
|
|
2043
1563
|
:param start_frame:
|
|
2044
1564
|
:param end_frame:
|
|
2045
1565
|
:param layer: the layer the action will play in (actions in different layers are added/blended together).
|
|
2046
|
-
:
|
|
2047
|
-
:param priority: only play this action if there isn't an action currently playing in this layer with a higher (lower number) priority.
|
|
2048
|
-
:type priority: int
|
|
1566
|
+
:param priority: only play this action if there isnt an action currently playing in this layer with a higher (lower number) priority.
|
|
2049
1567
|
:param blendin: the amount of blending between this animation and the previous one on this layer.
|
|
2050
|
-
:type blendin: float
|
|
2051
1568
|
:param play_mode: the play mode. one of `these constants <gameobject-playaction-mode>`.
|
|
2052
|
-
:type play_mode: int
|
|
2053
1569
|
:param layer_weight: how much of the previous layer to use for blending.
|
|
2054
|
-
:type layer_weight: float
|
|
2055
1570
|
:param ipo_flags: flags for the old IPO behaviors (force, etc).
|
|
2056
1571
|
:param speed: the playback speed of the action as a factor (1.0 = normal speed, 2.0 = 2x speed, etc).
|
|
2057
|
-
:type speed: float
|
|
2058
1572
|
:param blend_mode: how to blend this layer with previous layers. one of `these constants <gameobject-playaction-blend>`.
|
|
2059
|
-
:type blend_mode: int
|
|
2060
1573
|
"""
|
|
2061
1574
|
|
|
2062
|
-
def stopAction(self, layer: int):
|
|
1575
|
+
def stopAction(self, layer: int) -> None:
|
|
2063
1576
|
"""Stop playing the action on the given layer.
|
|
2064
1577
|
|
|
2065
1578
|
:param layer: The layer to stop playing, defaults to 0 if no value passed.
|
|
2066
|
-
:type layer: int
|
|
2067
1579
|
"""
|
|
2068
1580
|
|
|
2069
1581
|
def getActionFrame(self, layer: int) -> float:
|
|
2070
1582
|
"""Gets the current frame of the action playing in the supplied layer.
|
|
2071
1583
|
|
|
2072
1584
|
:param layer: The layer that you want to get the frame from, defaults to 0 if no value passed.
|
|
2073
|
-
:type layer: int
|
|
2074
1585
|
:return: The current frame of the action
|
|
2075
|
-
:rtype: float
|
|
2076
1586
|
"""
|
|
2077
1587
|
|
|
2078
1588
|
def getActionName(self, layer: int) -> str:
|
|
2079
1589
|
"""Gets the name of the current action playing in the supplied layer.
|
|
2080
1590
|
|
|
2081
1591
|
:param layer: The layer that you want to get the action name from, defaults to 0 if no value passed.
|
|
2082
|
-
:type layer: int
|
|
2083
1592
|
:return: The name of the current action
|
|
2084
|
-
:rtype: str
|
|
2085
1593
|
"""
|
|
2086
1594
|
|
|
2087
|
-
def setActionFrame(self, frame: float, layer: int):
|
|
1595
|
+
def setActionFrame(self, frame: float, layer: int) -> None:
|
|
2088
1596
|
"""Set the current frame of the action playing in the supplied layer.
|
|
2089
1597
|
|
|
2090
1598
|
:param frame: The frame to set the action to
|
|
2091
|
-
:type frame: float
|
|
2092
1599
|
:param layer: The layer where you want to set the frame, defaults to 0 if no value passed.
|
|
2093
|
-
:type layer: int
|
|
2094
1600
|
"""
|
|
2095
1601
|
|
|
2096
1602
|
def isPlayingAction(self, layer: int) -> bool:
|
|
2097
1603
|
"""Checks to see if there is an action playing in the given layer.
|
|
2098
1604
|
|
|
2099
1605
|
:param layer: The layer to check for a playing action, defaults to 0 if no value passed.
|
|
2100
|
-
:type layer: int
|
|
2101
1606
|
:return: Whether or not the action is playing
|
|
2102
|
-
:rtype: bool
|
|
2103
1607
|
"""
|
|
2104
1608
|
|
|
2105
|
-
def addDebugProperty(self, name: str, debug: bool):
|
|
1609
|
+
def addDebugProperty(self, name: str, debug: bool) -> None:
|
|
2106
1610
|
"""Adds a single debug property to the debug list.
|
|
2107
1611
|
|
|
2108
1612
|
:param name: name of the property that added to the debug list.
|
|
2109
|
-
:type name: str
|
|
2110
1613
|
:param debug: the debug state, defaults to True if no value passed.
|
|
2111
|
-
:type debug: bool
|
|
2112
1614
|
"""
|
|
2113
1615
|
|
|
2114
1616
|
class KX_LibLoadStatus:
|
|
2115
|
-
"""Libload is deprecated since 0.3
|
|
1617
|
+
"""Libload is deprecated since 0.3+. An object providing information about a LibLoad() operation."""
|
|
2116
1618
|
|
|
2117
1619
|
onFinish: collections.abc.Callable
|
|
2118
|
-
""" A callback that gets called when the lib load is done.
|
|
2119
|
-
|
|
2120
|
-
:type: collections.abc.Callable
|
|
2121
|
-
"""
|
|
1620
|
+
""" A callback that gets called when the lib load is done."""
|
|
2122
1621
|
|
|
2123
1622
|
finished: bool
|
|
2124
|
-
""" The current status of the lib load.
|
|
2125
|
-
|
|
2126
|
-
:type: bool
|
|
2127
|
-
"""
|
|
1623
|
+
""" The current status of the lib load."""
|
|
2128
1624
|
|
|
2129
1625
|
progress: float
|
|
2130
|
-
""" The current progress of the lib load as a normalized value from 0.0 to 1.0.
|
|
2131
|
-
|
|
2132
|
-
:type: float
|
|
2133
|
-
"""
|
|
1626
|
+
""" The current progress of the lib load as a normalized value from 0.0 to 1.0."""
|
|
2134
1627
|
|
|
2135
1628
|
libraryName: str
|
|
2136
|
-
""" The name of the library being loaded (the first argument to LibLoad).
|
|
2137
|
-
|
|
2138
|
-
:type: str
|
|
2139
|
-
"""
|
|
1629
|
+
""" The name of the library being loaded (the first argument to LibLoad)."""
|
|
2140
1630
|
|
|
2141
1631
|
timeTaken: float
|
|
2142
|
-
""" The amount of time, in seconds, the lib load took (0 until the operation is complete).
|
|
2143
|
-
|
|
2144
|
-
:type: float
|
|
2145
|
-
"""
|
|
1632
|
+
""" The amount of time, in seconds, the lib load took (0 until the operation is complete)."""
|
|
2146
1633
|
|
|
2147
1634
|
class KX_LightObject:
|
|
2148
1635
|
"""A Light game object.It is possible to use attributes from :type: `~bpy.types.Light`"""
|
|
@@ -2159,10 +1646,7 @@ class KX_LodLevel:
|
|
|
2159
1646
|
""" The mesh used for this lod level. (read only)"""
|
|
2160
1647
|
|
|
2161
1648
|
level: int
|
|
2162
|
-
""" The number of the lod level. (read only)
|
|
2163
|
-
|
|
2164
|
-
:type: int
|
|
2165
|
-
"""
|
|
1649
|
+
""" The number of the lod level. (read only)"""
|
|
2166
1650
|
|
|
2167
1651
|
distance: typing.Any
|
|
2168
1652
|
""" Distance to begin using this level of detail. (read only)"""
|
|
@@ -2173,10 +1657,7 @@ class KX_LodLevel:
|
|
|
2173
1657
|
useMesh: typing.Any
|
|
2174
1658
|
useMaterial: typing.Any
|
|
2175
1659
|
useHysteresis: bool
|
|
2176
|
-
""" Return true if the lod level uses hysteresis override. (read only)
|
|
2177
|
-
|
|
2178
|
-
:type: bool
|
|
2179
|
-
"""
|
|
1660
|
+
""" Return true if the lod level uses hysteresis override. (read only)"""
|
|
2180
1661
|
|
|
2181
1662
|
class KX_LodManager:
|
|
2182
1663
|
"""This class contains a list of all levels of detail used by a game object."""
|
|
@@ -2185,27 +1666,20 @@ class KX_LodManager:
|
|
|
2185
1666
|
""" Return the list of all levels of detail of the lod manager."""
|
|
2186
1667
|
|
|
2187
1668
|
distanceFactor: float
|
|
2188
|
-
""" Method to multiply the distance to the camera.
|
|
2189
|
-
|
|
2190
|
-
:type: float
|
|
2191
|
-
"""
|
|
1669
|
+
""" Method to multiply the distance to the camera."""
|
|
2192
1670
|
|
|
2193
1671
|
class KX_MeshProxy:
|
|
2194
|
-
"""A mesh object.You can only
|
|
1672
|
+
"""A mesh object.You can only read the vertex properties of a mesh object. In upbge 0.3+, KX_MeshProxy,
|
|
1673
|
+
KX_PolyProxy, and KX_VertexProxy are only a representation of the physics shape as it was
|
|
1674
|
+
when it was converted in BL_DataConversion.
|
|
1675
|
+
Previously this kind of meshes were used both for render and physics, but since 0.3+,
|
|
1676
|
+
it is only useful in limited cases. In most cases, bpy API should be used instead.Note:
|
|
1677
|
+
The physics simulation doesnt currently update KX_Mesh/Poly/VertexProxy.The correct method of iterating over every `~bge.types.KX_VertexProxy` in a game object
|
|
1678
|
+
"""
|
|
2195
1679
|
|
|
2196
1680
|
materials: typing.Any
|
|
2197
1681
|
numPolygons: int
|
|
2198
|
-
"""
|
|
2199
|
-
|
|
2200
|
-
:type: int
|
|
2201
|
-
"""
|
|
2202
|
-
|
|
2203
1682
|
numMaterials: int
|
|
2204
|
-
"""
|
|
2205
|
-
|
|
2206
|
-
:type: int
|
|
2207
|
-
"""
|
|
2208
|
-
|
|
2209
1683
|
polygons: typing.Any
|
|
2210
1684
|
""" Returns the list of polygons of this mesh."""
|
|
2211
1685
|
|
|
@@ -2213,81 +1687,42 @@ class KX_MeshProxy:
|
|
|
2213
1687
|
"""Gets the name of the specified material.
|
|
2214
1688
|
|
|
2215
1689
|
:param matid: the specified material.
|
|
2216
|
-
:type matid: int
|
|
2217
1690
|
:return: the attached material name.
|
|
2218
|
-
:rtype: str
|
|
2219
1691
|
"""
|
|
2220
1692
|
|
|
2221
1693
|
def getTextureName(self, matid: int) -> str:
|
|
2222
|
-
"""Gets the name of the specified
|
|
1694
|
+
"""Gets the name of the specified materials texture.
|
|
2223
1695
|
|
|
2224
1696
|
:param matid: the specified material
|
|
2225
|
-
:
|
|
2226
|
-
:return: the attached material's texture name.
|
|
2227
|
-
:rtype: str
|
|
1697
|
+
:return: the attached materials texture name.
|
|
2228
1698
|
"""
|
|
2229
1699
|
|
|
2230
1700
|
def getVertexArrayLength(self, matid: int) -> int:
|
|
2231
1701
|
"""Gets the length of the vertex array associated with the specified material.There is one vertex array for each material.
|
|
2232
1702
|
|
|
2233
1703
|
:param matid: the specified material
|
|
2234
|
-
:type matid: int
|
|
2235
1704
|
:return: the number of vertices in the vertex array.
|
|
2236
|
-
:rtype: int
|
|
2237
1705
|
"""
|
|
2238
1706
|
|
|
2239
|
-
def getVertex(self, matid: int, index: int):
|
|
1707
|
+
def getVertex(self, matid: int, index: int) -> None:
|
|
2240
1708
|
"""Gets the specified vertex from the mesh object.
|
|
2241
1709
|
|
|
2242
1710
|
:param matid: the specified material
|
|
2243
|
-
:type matid: int
|
|
2244
1711
|
:param index: the index into the vertex array.
|
|
2245
|
-
:type index: int
|
|
2246
1712
|
:return: a vertex object.
|
|
2247
1713
|
"""
|
|
2248
1714
|
|
|
2249
|
-
def getPolygon(self, index: int):
|
|
1715
|
+
def getPolygon(self, index: int) -> None:
|
|
2250
1716
|
"""Gets the specified polygon from the mesh.
|
|
2251
1717
|
|
|
2252
1718
|
:param index: polygon number
|
|
2253
|
-
:type index: int
|
|
2254
1719
|
:return: a polygon object.
|
|
2255
1720
|
"""
|
|
2256
1721
|
|
|
2257
|
-
def transform(self, matid: int, matrix):
|
|
2258
|
-
"""Transforms the vertices of a mesh.
|
|
2259
|
-
|
|
2260
|
-
:param matid: material index, -1 transforms all.
|
|
2261
|
-
:type matid: int
|
|
2262
|
-
:param matrix: transformation matrix.
|
|
2263
|
-
"""
|
|
2264
|
-
|
|
2265
|
-
def transformUV(
|
|
2266
|
-
self, matid: int, matrix, uv_index: int = -1, uv_index_from: int = -1
|
|
2267
|
-
):
|
|
2268
|
-
"""Transforms the vertices UV's of a mesh.
|
|
2269
|
-
|
|
2270
|
-
:param matid: material index, -1 transforms all.
|
|
2271
|
-
:type matid: int
|
|
2272
|
-
:param matrix: transformation matrix.
|
|
2273
|
-
:param uv_index: optional uv index, -1 for all, otherwise 0 or 1.
|
|
2274
|
-
:type uv_index: int
|
|
2275
|
-
:param uv_index_from: optional uv index to copy from, -1 to transform the current uv.
|
|
2276
|
-
:type uv_index_from: int
|
|
2277
|
-
"""
|
|
2278
|
-
|
|
2279
|
-
def replaceMaterial(self, matid: int, material):
|
|
2280
|
-
"""Replace the material in slot `matid` by the material `material`.
|
|
2281
|
-
|
|
2282
|
-
:param matid: The material index.
|
|
2283
|
-
:type matid: int
|
|
2284
|
-
:param material: The material replacement.
|
|
2285
|
-
"""
|
|
2286
|
-
|
|
2287
1722
|
class KX_NavMeshObject:
|
|
2288
1723
|
"""Python interface for using and controlling navigation meshes."""
|
|
2289
1724
|
|
|
2290
|
-
def findPath(self, start, goal):
|
|
1725
|
+
def findPath(self, start, goal) -> None:
|
|
2291
1726
|
"""Finds the path from start to goal points.
|
|
2292
1727
|
|
|
2293
1728
|
:param start: the start point3D Vector3D Vector
|
|
@@ -2301,85 +1736,61 @@ class KX_NavMeshObject:
|
|
|
2301
1736
|
:param start: the start point3D Vector3D Vector
|
|
2302
1737
|
:param goal: the goal point
|
|
2303
1738
|
:return: the hit factor
|
|
2304
|
-
:rtype: float
|
|
2305
1739
|
"""
|
|
2306
1740
|
|
|
2307
|
-
def draw(self, mode):
|
|
1741
|
+
def draw(self, mode) -> None:
|
|
2308
1742
|
"""Draws a debug mesh for the navigation mesh.
|
|
2309
1743
|
|
|
2310
1744
|
:param mode: the drawing mode (one of `these constants <navmesh-draw-mode>`)integer
|
|
2311
1745
|
:return: None
|
|
2312
1746
|
"""
|
|
2313
1747
|
|
|
2314
|
-
def rebuild(self):
|
|
1748
|
+
def rebuild(self) -> None:
|
|
2315
1749
|
"""Rebuild the navigation mesh.
|
|
2316
1750
|
|
|
2317
1751
|
:return: None
|
|
2318
1752
|
"""
|
|
2319
1753
|
|
|
2320
1754
|
class KX_PolyProxy:
|
|
2321
|
-
"""A polygon holds the index of the vertex forming the poylgon.
|
|
2322
|
-
|
|
2323
|
-
|
|
1755
|
+
"""A polygon holds the index of the vertex forming the poylgon.
|
|
1756
|
+
You can only read the vertex properties of a mesh object. In upbge 0.3+, KX_MeshProxy,
|
|
1757
|
+
KX_PolyProxy, and KX_VertexProxy are only a representation of the physics shape as it was
|
|
1758
|
+
when it was converted in BL_DataConversion.
|
|
1759
|
+
Previously this kind of meshes were used both for render and physics, but since 0.3+,
|
|
1760
|
+
it is only useful in limited cases. In most cases, bpy API should be used instead.Note:
|
|
1761
|
+
The physics simulation doesnt currently update KX_Mesh/Poly/VertexProxy.
|
|
2324
1762
|
"""
|
|
2325
1763
|
|
|
2326
1764
|
material_name: str
|
|
2327
|
-
""" The name of polygon material, empty if no material.
|
|
2328
|
-
|
|
2329
|
-
:type: str
|
|
2330
|
-
"""
|
|
1765
|
+
""" The name of polygon material, empty if no material."""
|
|
2331
1766
|
|
|
2332
1767
|
material: typing.Any
|
|
2333
1768
|
""" The material of the polygon."""
|
|
2334
1769
|
|
|
2335
1770
|
texture_name: str
|
|
2336
|
-
""" The texture name of the polygon.
|
|
2337
|
-
|
|
2338
|
-
:type: str
|
|
2339
|
-
"""
|
|
1771
|
+
""" The texture name of the polygon."""
|
|
2340
1772
|
|
|
2341
1773
|
material_id: int
|
|
2342
|
-
""" The material index of the polygon, use this to retrieve vertex proxy from mesh proxy.
|
|
2343
|
-
|
|
2344
|
-
:type: int
|
|
2345
|
-
"""
|
|
1774
|
+
""" The material index of the polygon, use this to retrieve vertex proxy from mesh proxy."""
|
|
2346
1775
|
|
|
2347
1776
|
v1: int
|
|
2348
|
-
""" vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
|
|
2349
|
-
|
|
2350
|
-
:type: int
|
|
2351
|
-
"""
|
|
1777
|
+
""" vertex index of the first vertex of the polygon, use this to retrieve vertex proxy from mesh proxy."""
|
|
2352
1778
|
|
|
2353
1779
|
v2: int
|
|
2354
|
-
""" vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
|
|
2355
|
-
|
|
2356
|
-
:type: int
|
|
2357
|
-
"""
|
|
1780
|
+
""" vertex index of the second vertex of the polygon, use this to retrieve vertex proxy from mesh proxy."""
|
|
2358
1781
|
|
|
2359
1782
|
v3: int
|
|
2360
|
-
""" vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy.
|
|
2361
|
-
|
|
2362
|
-
:type: int
|
|
2363
|
-
"""
|
|
1783
|
+
""" vertex index of the third vertex of the polygon, use this to retrieve vertex proxy from mesh proxy."""
|
|
2364
1784
|
|
|
2365
1785
|
v4: int
|
|
2366
1786
|
""" Vertex index of the fourth vertex of the polygon, 0 if polygon has only 3 vertex
|
|
2367
|
-
Use this to retrieve vertex proxy from mesh proxy.
|
|
2368
|
-
|
|
2369
|
-
:type: int
|
|
2370
|
-
"""
|
|
1787
|
+
Use this to retrieve vertex proxy from mesh proxy."""
|
|
2371
1788
|
|
|
2372
1789
|
visible: int
|
|
2373
|
-
""" visible state of the polygon: 1=visible, 0=invisible.
|
|
2374
|
-
|
|
2375
|
-
:type: int
|
|
2376
|
-
"""
|
|
1790
|
+
""" visible state of the polygon: 1=visible, 0=invisible."""
|
|
2377
1791
|
|
|
2378
1792
|
collide: int
|
|
2379
|
-
""" collide state of the polygon: 1=receives collision, 0=collision free.
|
|
2380
|
-
|
|
2381
|
-
:type: int
|
|
2382
|
-
"""
|
|
1793
|
+
""" collide state of the polygon: 1=receives collision, 0=collision free."""
|
|
2383
1794
|
|
|
2384
1795
|
vertices: typing.Any
|
|
2385
1796
|
""" Returns the list of vertices of this polygon."""
|
|
@@ -2388,10 +1799,9 @@ Use this to retrieve vertex proxy from mesh proxy.
|
|
|
2388
1799
|
"""Returns the polygon material name with MA prefix
|
|
2389
1800
|
|
|
2390
1801
|
:return: material name
|
|
2391
|
-
:rtype: str
|
|
2392
1802
|
"""
|
|
2393
1803
|
|
|
2394
|
-
def getMaterial(self):
|
|
1804
|
+
def getMaterial(self) -> None:
|
|
2395
1805
|
"""
|
|
2396
1806
|
|
|
2397
1807
|
:return: The polygon material
|
|
@@ -2401,7 +1811,6 @@ Use this to retrieve vertex proxy from mesh proxy.
|
|
|
2401
1811
|
"""
|
|
2402
1812
|
|
|
2403
1813
|
:return: The texture name
|
|
2404
|
-
:rtype: str
|
|
2405
1814
|
"""
|
|
2406
1815
|
|
|
2407
1816
|
def getMaterialIndex(self) -> int:
|
|
@@ -2409,28 +1818,24 @@ Use this to retrieve vertex proxy from mesh proxy.
|
|
|
2409
1818
|
This index and the ones returned by getVertexIndex() are needed to retrieve the vertex proxy from `~bge.types.KX_MeshProxy`.
|
|
2410
1819
|
|
|
2411
1820
|
:return: the material index in the mesh
|
|
2412
|
-
:rtype: int
|
|
2413
1821
|
"""
|
|
2414
1822
|
|
|
2415
1823
|
def getNumVertex(self) -> int:
|
|
2416
1824
|
"""Returns the number of vertex of the polygon.
|
|
2417
1825
|
|
|
2418
1826
|
:return: number of vertex, 3 or 4.
|
|
2419
|
-
:rtype: int
|
|
2420
1827
|
"""
|
|
2421
1828
|
|
|
2422
1829
|
def isVisible(self) -> bool:
|
|
2423
1830
|
"""Returns whether the polygon is visible or not
|
|
2424
1831
|
|
|
2425
1832
|
:return: 0=invisible, 1=visible
|
|
2426
|
-
:rtype: bool
|
|
2427
1833
|
"""
|
|
2428
1834
|
|
|
2429
1835
|
def isCollider(self) -> int:
|
|
2430
1836
|
"""Returns whether the polygon is receives collision or not
|
|
2431
1837
|
|
|
2432
1838
|
:return: 0=collision free, 1=receives collision
|
|
2433
|
-
:rtype: int
|
|
2434
1839
|
"""
|
|
2435
1840
|
|
|
2436
1841
|
def getVertexIndex(self, vertex) -> int:
|
|
@@ -2439,10 +1844,9 @@ Use this to retrieve vertex proxy from mesh proxy.
|
|
|
2439
1844
|
|
|
2440
1845
|
:param vertex: index of the vertex in the polygon: 0->3integer
|
|
2441
1846
|
:return: mesh vertex index
|
|
2442
|
-
:rtype: int
|
|
2443
1847
|
"""
|
|
2444
1848
|
|
|
2445
|
-
def getMesh(self):
|
|
1849
|
+
def getMesh(self) -> None:
|
|
2446
1850
|
"""Returns a mesh proxy
|
|
2447
1851
|
|
|
2448
1852
|
:return: mesh proxy
|
|
@@ -2452,13 +1856,13 @@ class KX_PythonComponent:
|
|
|
2452
1856
|
"""Python component can be compared to python logic bricks with parameters.
|
|
2453
1857
|
The python component is a script loaded in the UI, this script defined a component class by inheriting from `~bge.types.KX_PythonComponent`.
|
|
2454
1858
|
This class must contain a dictionary of properties: `args` and two default functions: `start` and `update`.The script must have .py extension.The component properties are loaded from the `args` attribute from the UI at loading time.
|
|
2455
|
-
When the game start the function `start` is called with as arguments a dictionary of the properties
|
|
1859
|
+
When the game start the function `start` is called with as arguments a dictionary of the properties name and value.
|
|
2456
1860
|
The `update` function is called every frames during the logic stage before running logics bricks,
|
|
2457
1861
|
the goal of this function is to handle and process everything.The following component example moves and rotates the object when pressing the keys W, A, S and D.Since the components are loaded for the first time outside the bge, then `bge` is a fake module that contains only the class
|
|
2458
1862
|
`~bge.types.KX_PythonComponent` to avoid importing all the bge modules.
|
|
2459
1863
|
This behavior is safer but creates some issues at loading when the user want to use functions or attributes from the bge modules other
|
|
2460
1864
|
than the `~bge.types.KX_PythonComponent` class. The way is to not call these functions at loading outside the bge. To detect it, the bge
|
|
2461
|
-
module contains the attribute `__component__` when
|
|
1865
|
+
module contains the attribute `__component__` when its imported outside the bge.The following component example add a "Cube" object at initialization and move it along x for each update. It shows that the user can
|
|
2462
1866
|
use functions from scene and load the component outside the bge by setting global attributes in a condition at the beginning of the
|
|
2463
1867
|
script.The property types supported are float, integer, boolean, string, set (for enumeration) and Vector 2D, 3D and 4D. The following example
|
|
2464
1868
|
show all of these property types.
|
|
@@ -2468,32 +1872,25 @@ class KX_PythonComponent:
|
|
|
2468
1872
|
""" The object owner of the component."""
|
|
2469
1873
|
|
|
2470
1874
|
args: dict
|
|
2471
|
-
""" Dictionary of the component properties, the keys are string and the value can be: float, integer, Vector(2D/3D/4D), set, string.
|
|
2472
|
-
|
|
2473
|
-
:type: dict
|
|
2474
|
-
"""
|
|
1875
|
+
""" Dictionary of the component properties, the keys are string and the value can be: float, integer, Vector(2D/3D/4D), set, string."""
|
|
2475
1876
|
|
|
2476
1877
|
logger: typing.Any
|
|
2477
1878
|
""" A logger instance that can be used to log messages related to this object (read-only)."""
|
|
2478
1879
|
|
|
2479
1880
|
loggerName: str
|
|
2480
1881
|
""" A name used to create the logger instance. By default, it takes the form Type[Name]
|
|
2481
|
-
and can be optionally overridden as below:
|
|
2482
|
-
|
|
2483
|
-
:type: str
|
|
2484
|
-
"""
|
|
1882
|
+
and can be optionally overridden as below:"""
|
|
2485
1883
|
|
|
2486
|
-
def start(self, args: dict):
|
|
1884
|
+
def start(self, args: dict) -> None:
|
|
2487
1885
|
"""Initialize the component.
|
|
2488
1886
|
|
|
2489
|
-
:param args: The dictionary of the properties
|
|
2490
|
-
:type args: dict
|
|
1887
|
+
:param args: The dictionary of the properties name and value.
|
|
2491
1888
|
"""
|
|
2492
1889
|
|
|
2493
|
-
def update(self):
|
|
1890
|
+
def update(self) -> None:
|
|
2494
1891
|
"""Process the logic of the component."""
|
|
2495
1892
|
|
|
2496
|
-
def dispose(self):
|
|
1893
|
+
def dispose(self) -> None:
|
|
2497
1894
|
"""Function called when the component is destroyed."""
|
|
2498
1895
|
|
|
2499
1896
|
class KX_Scene:
|
|
@@ -2511,10 +1908,7 @@ class KX_Scene:
|
|
|
2511
1908
|
"""
|
|
2512
1909
|
|
|
2513
1910
|
name: str
|
|
2514
|
-
""" The scene's name, (read-only).
|
|
2515
|
-
|
|
2516
|
-
:type: str
|
|
2517
|
-
"""
|
|
1911
|
+
""" The scene's name, (read-only)."""
|
|
2518
1912
|
|
|
2519
1913
|
objects: typing.Any
|
|
2520
1914
|
""" A list of objects in the scene, (read-only)."""
|
|
@@ -2541,36 +1935,21 @@ class KX_Scene:
|
|
|
2541
1935
|
|
|
2542
1936
|
suspended: typing.Any
|
|
2543
1937
|
activityCulling: bool
|
|
2544
|
-
""" True if the scene allow object activity culling.
|
|
2545
|
-
|
|
2546
|
-
:type: bool
|
|
2547
|
-
"""
|
|
1938
|
+
""" True if the scene allow object activity culling."""
|
|
2548
1939
|
|
|
2549
1940
|
dbvt_culling: typing.Any
|
|
2550
1941
|
pre_draw: list
|
|
2551
|
-
""" A list of callables to be run before the render step. The callbacks can take as argument the rendered camera.
|
|
2552
|
-
|
|
2553
|
-
:type: list
|
|
2554
|
-
"""
|
|
1942
|
+
""" A list of callables to be run before the render step. The callbacks can take as argument the rendered camera."""
|
|
2555
1943
|
|
|
2556
1944
|
post_draw: list
|
|
2557
|
-
""" A list of callables to be run after the render step.
|
|
2558
|
-
|
|
2559
|
-
:type: list
|
|
2560
|
-
"""
|
|
1945
|
+
""" A list of callables to be run after the render step."""
|
|
2561
1946
|
|
|
2562
1947
|
pre_draw_setup: list
|
|
2563
1948
|
""" A list of callables to be run before the drawing setup (i.e., before the model view and projection matrices are computed).
|
|
2564
|
-
The callbacks can take as argument the rendered camera, the camera could be temporary in case of stereo rendering.
|
|
2565
|
-
|
|
2566
|
-
:type: list
|
|
2567
|
-
"""
|
|
1949
|
+
The callbacks can take as argument the rendered camera, the camera could be temporary in case of stereo rendering."""
|
|
2568
1950
|
|
|
2569
1951
|
onRemove: list
|
|
2570
|
-
""" A list of callables to run when the scene is destroyed.
|
|
2571
|
-
|
|
2572
|
-
:type: list
|
|
2573
|
-
"""
|
|
1952
|
+
""" A list of callables to run when the scene is destroyed."""
|
|
2574
1953
|
|
|
2575
1954
|
gravity: typing.Any
|
|
2576
1955
|
""" The scene gravity using the world x, y and z axis."""
|
|
@@ -2579,10 +1958,7 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2579
1958
|
""" A logger instance that can be used to log messages related to this object (read-only)."""
|
|
2580
1959
|
|
|
2581
1960
|
loggerName: str
|
|
2582
|
-
""" A name used to create the logger instance. By default, it takes the form KX_Scene[Name].
|
|
2583
|
-
|
|
2584
|
-
:type: str
|
|
2585
|
-
"""
|
|
1961
|
+
""" A name used to create the logger instance. By default, it takes the form KX_Scene[Name]."""
|
|
2586
1962
|
|
|
2587
1963
|
def addObject(
|
|
2588
1964
|
self,
|
|
@@ -2590,38 +1966,32 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2590
1966
|
reference: str | None = "",
|
|
2591
1967
|
time: float = 0.0,
|
|
2592
1968
|
dupli: bool = False,
|
|
2593
|
-
):
|
|
1969
|
+
) -> None:
|
|
2594
1970
|
"""Adds an object to the scene like the Add Object Actuator would.
|
|
2595
1971
|
|
|
2596
1972
|
:param object: The (name of the) object to add.
|
|
2597
|
-
:
|
|
2598
|
-
:param reference: The (name of the) object which position, orientation, and scale to copy (optional), if the object to add is a light and there is not reference the light's layer will be the same that the active layer in the blender scene.
|
|
2599
|
-
:type reference: str | None
|
|
1973
|
+
:param reference: The (name of the) object which position, orientation, and scale to copy (optional), if the object to add is a light and there is not reference the lights layer will be the same that the active layer in the blender scene.
|
|
2600
1974
|
:param time: The lifetime of the added object, in frames (assumes one frame is 1/60 second). A time of 0.0 means the object will last forever (optional).
|
|
2601
|
-
:type time: float
|
|
2602
1975
|
:param dupli: Full duplication of object data (mesh, materials...).
|
|
2603
|
-
:type dupli: bool
|
|
2604
1976
|
:return: The newly added object.
|
|
2605
1977
|
"""
|
|
2606
1978
|
|
|
2607
|
-
def end(self):
|
|
1979
|
+
def end(self) -> None:
|
|
2608
1980
|
"""Removes the scene from the game."""
|
|
2609
1981
|
|
|
2610
|
-
def restart(self):
|
|
1982
|
+
def restart(self) -> None:
|
|
2611
1983
|
"""Restarts the scene."""
|
|
2612
1984
|
|
|
2613
1985
|
def replace(self, scene: str) -> bool:
|
|
2614
1986
|
"""Replaces this scene with another one.
|
|
2615
1987
|
|
|
2616
1988
|
:param scene: The name of the scene to replace this scene with.
|
|
2617
|
-
:type scene: str
|
|
2618
1989
|
:return: True if the scene exists and was scheduled for addition, False otherwise.
|
|
2619
|
-
:rtype: bool
|
|
2620
1990
|
"""
|
|
2621
1991
|
|
|
2622
|
-
def suspend(self): ...
|
|
2623
|
-
def resume(self): ...
|
|
2624
|
-
def get(self, key, default=None):
|
|
1992
|
+
def suspend(self) -> None: ...
|
|
1993
|
+
def resume(self) -> None: ...
|
|
1994
|
+
def get(self, key, default=None) -> None:
|
|
2625
1995
|
"""Return the value matching key, or the default value if its not found.
|
|
2626
1996
|
:return: The key value or a default.
|
|
2627
1997
|
|
|
@@ -2629,10 +1999,10 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2629
1999
|
:param default:
|
|
2630
2000
|
"""
|
|
2631
2001
|
|
|
2632
|
-
def drawObstacleSimulation(self):
|
|
2002
|
+
def drawObstacleSimulation(self) -> None:
|
|
2633
2003
|
"""Draw debug visualization of obstacle simulation."""
|
|
2634
2004
|
|
|
2635
|
-
def convertBlenderObject(self, blenderObject):
|
|
2005
|
+
def convertBlenderObject(self, blenderObject) -> None:
|
|
2636
2006
|
"""Converts a `~bpy.types.Object` into a `~bge.types.KX_GameObject` during runtime.
|
|
2637
2007
|
For example, you can append an Object from another .blend file during bge runtime
|
|
2638
2008
|
using: bpy.ops.wm.append(...) then convert this Object into a KX_GameObject to have
|
|
@@ -2642,7 +2012,7 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2642
2012
|
:return: Returns the newly converted gameobject.
|
|
2643
2013
|
"""
|
|
2644
2014
|
|
|
2645
|
-
def convertBlenderObjectsList(self, blenderObjectsList, asynchronous: bool):
|
|
2015
|
+
def convertBlenderObjectsList(self, blenderObjectsList, asynchronous: bool) -> None:
|
|
2646
2016
|
"""Converts all bpy.types.Object inside a python List into its correspondent `~bge.types.KX_GameObject` during runtime.
|
|
2647
2017
|
For example, you can append an Object List during bge runtime using: ob = object_data_add(...) and ML.append(ob) then convert the Objects
|
|
2648
2018
|
inside the List into several KX_GameObject to have logic bricks, physics... converted. This is meant to replace libload.
|
|
@@ -2650,10 +2020,9 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2650
2020
|
|
|
2651
2021
|
:param blenderObjectsList: The Object list to be converted.
|
|
2652
2022
|
:param asynchronous: The Object list conversion can be asynchronous or not.
|
|
2653
|
-
:type asynchronous: bool
|
|
2654
2023
|
"""
|
|
2655
2024
|
|
|
2656
|
-
def convertBlenderCollection(self, blenderCollection, asynchronous: bool):
|
|
2025
|
+
def convertBlenderCollection(self, blenderCollection, asynchronous: bool) -> None:
|
|
2657
2026
|
"""Converts all bpy.types.Object inside a Collection into its correspondent `~bge.types.KX_GameObject` during runtime.
|
|
2658
2027
|
For example, you can append a Collection from another .blend file during bge runtime
|
|
2659
2028
|
using: bpy.ops.wm.append(...) then convert the Objects inside the Collection into several KX_GameObject to have
|
|
@@ -2662,10 +2031,9 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2662
2031
|
|
|
2663
2032
|
:param blenderCollection: The collection to be converted.
|
|
2664
2033
|
:param asynchronous: The collection conversion can be asynchronous or not.
|
|
2665
|
-
:type asynchronous: bool
|
|
2666
2034
|
"""
|
|
2667
2035
|
|
|
2668
|
-
def convertBlenderAction(self, Action):
|
|
2036
|
+
def convertBlenderAction(self, Action) -> None:
|
|
2669
2037
|
"""Registers a bpy.types.Action into the bge logic manager to be abled to play it during runtime.
|
|
2670
2038
|
For example, you can append an Action from another .blend file during bge runtime
|
|
2671
2039
|
using: bpy.ops.wm.append(...) then register this Action to be abled to play it.
|
|
@@ -2673,17 +2041,17 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2673
2041
|
:param Action: The Action to be converted.
|
|
2674
2042
|
"""
|
|
2675
2043
|
|
|
2676
|
-
def unregisterBlenderAction(self, Action):
|
|
2044
|
+
def unregisterBlenderAction(self, Action) -> None:
|
|
2677
2045
|
"""Unregisters a bpy.types.Action from the bge logic manager.
|
|
2678
2046
|
The unregistered action will still be in the .blend file
|
|
2679
|
-
but
|
|
2047
|
+
but cant be played anymore with bge. If you want to completely
|
|
2680
2048
|
remove the action you need to call bpy.data.actions.remove(Action, do_unlink=True)
|
|
2681
2049
|
after you unregistered it from bge logic manager.
|
|
2682
2050
|
|
|
2683
2051
|
:param Action: The Action to be unregistered.
|
|
2684
2052
|
"""
|
|
2685
2053
|
|
|
2686
|
-
def addOverlayCollection(self, kxCamera, blenderCollection):
|
|
2054
|
+
def addOverlayCollection(self, kxCamera, blenderCollection) -> None:
|
|
2687
2055
|
"""Adds an overlay collection (as with collection actuator) to render this collection objects
|
|
2688
2056
|
during a second render pass in overlay using the KX_Camera passed as argument.
|
|
2689
2057
|
|
|
@@ -2691,17 +2059,16 @@ The callbacks can take as argument the rendered camera, the camera could be temp
|
|
|
2691
2059
|
:param blenderCollection: The overlay collection to add.
|
|
2692
2060
|
"""
|
|
2693
2061
|
|
|
2694
|
-
def removeOverlayCollection(self, blenderCollection):
|
|
2062
|
+
def removeOverlayCollection(self, blenderCollection) -> None:
|
|
2695
2063
|
"""Removes an overlay collection (as with collection actuator).
|
|
2696
2064
|
|
|
2697
2065
|
:param blenderCollection: The overlay collection to remove.
|
|
2698
2066
|
"""
|
|
2699
2067
|
|
|
2700
|
-
def getGameObjectFromObject(self, blenderObject: bpy.types.Object):
|
|
2068
|
+
def getGameObjectFromObject(self, blenderObject: bpy.types.Object) -> None:
|
|
2701
2069
|
"""Get the KX_GameObject corresponding to the blenderObject.
|
|
2702
2070
|
|
|
2703
2071
|
:param blenderObject: the Object from which we want to get the KX_GameObject.
|
|
2704
|
-
:type blenderObject: bpy.types.Object
|
|
2705
2072
|
"""
|
|
2706
2073
|
|
|
2707
2074
|
class KX_VehicleWrapper:
|
|
@@ -2719,7 +2086,7 @@ class KX_VehicleWrapper:
|
|
|
2719
2086
|
suspensionRestLength: float,
|
|
2720
2087
|
wheelRadius: float,
|
|
2721
2088
|
hasSteering: bool,
|
|
2722
|
-
):
|
|
2089
|
+
) -> None:
|
|
2723
2090
|
"""Add a wheel to the vehicle
|
|
2724
2091
|
|
|
2725
2092
|
:param wheel: The object to use as a wheel.
|
|
@@ -2727,57 +2094,46 @@ class KX_VehicleWrapper:
|
|
|
2727
2094
|
:param downDir: The direction vector pointing down to where the vehicle should collide with the floor.
|
|
2728
2095
|
:param axleDir: The axis the wheel rotates around, relative to the chassis.
|
|
2729
2096
|
:param suspensionRestLength: The length of the suspension when no forces are being applied.
|
|
2730
|
-
:type suspensionRestLength: float
|
|
2731
2097
|
:param wheelRadius: The radius of the wheel (half the diameter).
|
|
2732
|
-
:type wheelRadius: float
|
|
2733
2098
|
:param hasSteering: True if the wheel should turn with steering, typically used in front wheels.
|
|
2734
|
-
:type hasSteering: bool
|
|
2735
2099
|
"""
|
|
2736
2100
|
|
|
2737
|
-
def applyBraking(self, force: float, wheelIndex: int):
|
|
2101
|
+
def applyBraking(self, force: float, wheelIndex: int) -> None:
|
|
2738
2102
|
"""Apply a braking force to the specified wheel
|
|
2739
2103
|
|
|
2740
2104
|
:param force: the brake force
|
|
2741
|
-
:type force: float
|
|
2742
2105
|
:param wheelIndex: index of the wheel where the force needs to be applied
|
|
2743
|
-
:type wheelIndex: int
|
|
2744
2106
|
"""
|
|
2745
2107
|
|
|
2746
|
-
def applyEngineForce(self, force: float, wheelIndex: int):
|
|
2108
|
+
def applyEngineForce(self, force: float, wheelIndex: int) -> None:
|
|
2747
2109
|
"""Apply an engine force to the specified wheel
|
|
2748
2110
|
|
|
2749
2111
|
:param force: the engine force
|
|
2750
|
-
:type force: float
|
|
2751
2112
|
:param wheelIndex: index of the wheel where the force needs to be applied
|
|
2752
|
-
:type wheelIndex: int
|
|
2753
2113
|
"""
|
|
2754
2114
|
|
|
2755
2115
|
def getConstraintId(self) -> int:
|
|
2756
2116
|
"""Get the constraint ID
|
|
2757
2117
|
|
|
2758
2118
|
:return: the constraint id
|
|
2759
|
-
:rtype: int
|
|
2760
2119
|
"""
|
|
2761
2120
|
|
|
2762
2121
|
def getConstraintType(self) -> int:
|
|
2763
2122
|
"""Returns the constraint type.
|
|
2764
2123
|
|
|
2765
2124
|
:return: constraint type
|
|
2766
|
-
:rtype: int
|
|
2767
2125
|
"""
|
|
2768
2126
|
|
|
2769
2127
|
def getNumWheels(self) -> int:
|
|
2770
2128
|
"""Returns the number of wheels.
|
|
2771
2129
|
|
|
2772
2130
|
:return: the number of wheels for this vehicle
|
|
2773
|
-
:rtype: int
|
|
2774
2131
|
"""
|
|
2775
2132
|
|
|
2776
|
-
def getWheelOrientationQuaternion(self, wheelIndex: int):
|
|
2133
|
+
def getWheelOrientationQuaternion(self, wheelIndex: int) -> None:
|
|
2777
2134
|
"""Returns the wheel orientation as a quaternion.
|
|
2778
2135
|
|
|
2779
2136
|
:param wheelIndex: the wheel index
|
|
2780
|
-
:type wheelIndex: int
|
|
2781
2137
|
:return: TODO Description
|
|
2782
2138
|
"""
|
|
2783
2139
|
|
|
@@ -2785,79 +2141,67 @@ class KX_VehicleWrapper:
|
|
|
2785
2141
|
"""Returns the position of the specified wheel
|
|
2786
2142
|
|
|
2787
2143
|
:param wheelIndex: the wheel index
|
|
2788
|
-
:type wheelIndex: int
|
|
2789
2144
|
:return: position vector
|
|
2790
|
-
:rtype: list
|
|
2791
2145
|
"""
|
|
2792
2146
|
|
|
2793
2147
|
def getWheelRotation(self, wheelIndex: int) -> float:
|
|
2794
2148
|
"""Returns the rotation of the specified wheel
|
|
2795
2149
|
|
|
2796
2150
|
:param wheelIndex: the wheel index
|
|
2797
|
-
:type wheelIndex: int
|
|
2798
2151
|
:return: the wheel rotation
|
|
2799
|
-
:rtype: float
|
|
2800
2152
|
"""
|
|
2801
2153
|
|
|
2802
|
-
def setRollInfluence(self, rollInfluece: float, wheelIndex: int):
|
|
2803
|
-
"""Set the specified
|
|
2154
|
+
def setRollInfluence(self, rollInfluece: float, wheelIndex: int) -> None:
|
|
2155
|
+
"""Set the specified wheels roll influence.
|
|
2804
2156
|
The higher the roll influence the more the vehicle will tend to roll over in corners.
|
|
2805
2157
|
|
|
2806
2158
|
:param rollInfluece: the wheel roll influence
|
|
2807
|
-
:type rollInfluece: float
|
|
2808
2159
|
:param wheelIndex: the wheel index
|
|
2809
|
-
:type wheelIndex: int
|
|
2810
2160
|
"""
|
|
2811
2161
|
|
|
2812
|
-
def setSteeringValue(self, steering: float, wheelIndex: int):
|
|
2813
|
-
"""Set the specified
|
|
2162
|
+
def setSteeringValue(self, steering: float, wheelIndex: int) -> None:
|
|
2163
|
+
"""Set the specified wheels steering
|
|
2814
2164
|
|
|
2815
2165
|
:param steering: the wheel steering
|
|
2816
|
-
:type steering: float
|
|
2817
2166
|
:param wheelIndex: the wheel index
|
|
2818
|
-
:type wheelIndex: int
|
|
2819
2167
|
"""
|
|
2820
2168
|
|
|
2821
|
-
def setSuspensionCompression(self, compression: float, wheelIndex: int):
|
|
2822
|
-
"""Set the specified
|
|
2169
|
+
def setSuspensionCompression(self, compression: float, wheelIndex: int) -> None:
|
|
2170
|
+
"""Set the specified wheels compression
|
|
2823
2171
|
|
|
2824
2172
|
:param compression: the wheel compression
|
|
2825
|
-
:type compression: float
|
|
2826
2173
|
:param wheelIndex: the wheel index
|
|
2827
|
-
:type wheelIndex: int
|
|
2828
2174
|
"""
|
|
2829
2175
|
|
|
2830
|
-
def setSuspensionDamping(self, damping: float, wheelIndex: int):
|
|
2831
|
-
"""Set the specified
|
|
2176
|
+
def setSuspensionDamping(self, damping: float, wheelIndex: int) -> None:
|
|
2177
|
+
"""Set the specified wheels damping
|
|
2832
2178
|
|
|
2833
2179
|
:param damping: the wheel damping
|
|
2834
|
-
:type damping: float
|
|
2835
2180
|
:param wheelIndex: the wheel index
|
|
2836
|
-
:type wheelIndex: int
|
|
2837
2181
|
"""
|
|
2838
2182
|
|
|
2839
|
-
def setSuspensionStiffness(self, stiffness: float, wheelIndex: int):
|
|
2840
|
-
"""Set the specified
|
|
2183
|
+
def setSuspensionStiffness(self, stiffness: float, wheelIndex: int) -> None:
|
|
2184
|
+
"""Set the specified wheels stiffness
|
|
2841
2185
|
|
|
2842
2186
|
:param stiffness: the wheel stiffness
|
|
2843
|
-
:type stiffness: float
|
|
2844
2187
|
:param wheelIndex: the wheel index
|
|
2845
|
-
:type wheelIndex: int
|
|
2846
2188
|
"""
|
|
2847
2189
|
|
|
2848
|
-
def setTyreFriction(self, friction: float, wheelIndex: int):
|
|
2849
|
-
"""Set the specified
|
|
2190
|
+
def setTyreFriction(self, friction: float, wheelIndex: int) -> None:
|
|
2191
|
+
"""Set the specified wheels tyre friction
|
|
2850
2192
|
|
|
2851
2193
|
:param friction: the tyre friction
|
|
2852
|
-
:type friction: float
|
|
2853
2194
|
:param wheelIndex: the wheel index
|
|
2854
|
-
:type wheelIndex: int
|
|
2855
2195
|
"""
|
|
2856
2196
|
|
|
2857
2197
|
class KX_VertexProxy:
|
|
2858
|
-
"""A vertex holds position, UV, color and normal information.
|
|
2859
|
-
|
|
2860
|
-
|
|
2198
|
+
"""A vertex holds position, UV, color and normal information.
|
|
2199
|
+
You can only read the vertex properties of a mesh object. In upbge 0.3+, KX_MeshProxy,
|
|
2200
|
+
KX_PolyProxy, and KX_VertexProxy are only a representation of the physics shape as it was
|
|
2201
|
+
when it was converted in BL_DataConversion.
|
|
2202
|
+
Previously this kind of meshes were used both for render and physics, but since 0.3+,
|
|
2203
|
+
it is only useful in limited cases. In most cases, bpy API should be used instead.Note:
|
|
2204
|
+
The physics simulation doesnt currently update KX_Mesh/Poly/VertexProxy.
|
|
2861
2205
|
"""
|
|
2862
2206
|
|
|
2863
2207
|
XYZ: typing.Any
|
|
@@ -2879,143 +2223,75 @@ class KX_VertexProxy:
|
|
|
2879
2223
|
""" The color list of the vertex."""
|
|
2880
2224
|
|
|
2881
2225
|
x: float
|
|
2882
|
-
""" The x coordinate of the vertex.
|
|
2883
|
-
|
|
2884
|
-
:type: float
|
|
2885
|
-
"""
|
|
2226
|
+
""" The x coordinate of the vertex."""
|
|
2886
2227
|
|
|
2887
2228
|
y: float
|
|
2888
|
-
""" The y coordinate of the vertex.
|
|
2889
|
-
|
|
2890
|
-
:type: float
|
|
2891
|
-
"""
|
|
2229
|
+
""" The y coordinate of the vertex."""
|
|
2892
2230
|
|
|
2893
2231
|
z: float
|
|
2894
|
-
""" The z coordinate of the vertex.
|
|
2895
|
-
|
|
2896
|
-
:type: float
|
|
2897
|
-
"""
|
|
2232
|
+
""" The z coordinate of the vertex."""
|
|
2898
2233
|
|
|
2899
2234
|
u: float
|
|
2900
|
-
""" The u texture coordinate of the vertex.
|
|
2901
|
-
|
|
2902
|
-
:type: float
|
|
2903
|
-
"""
|
|
2235
|
+
""" The u texture coordinate of the vertex."""
|
|
2904
2236
|
|
|
2905
2237
|
v: float
|
|
2906
|
-
""" The v texture coordinate of the vertex.
|
|
2907
|
-
|
|
2908
|
-
:type: float
|
|
2909
|
-
"""
|
|
2238
|
+
""" The v texture coordinate of the vertex."""
|
|
2910
2239
|
|
|
2911
2240
|
u2: float
|
|
2912
|
-
""" The second u texture coordinate of the vertex.
|
|
2913
|
-
|
|
2914
|
-
:type: float
|
|
2915
|
-
"""
|
|
2241
|
+
""" The second u texture coordinate of the vertex."""
|
|
2916
2242
|
|
|
2917
2243
|
v2: float
|
|
2918
|
-
""" The second v texture coordinate of the vertex.
|
|
2919
|
-
|
|
2920
|
-
:type: float
|
|
2921
|
-
"""
|
|
2244
|
+
""" The second v texture coordinate of the vertex."""
|
|
2922
2245
|
|
|
2923
2246
|
r: float
|
|
2924
|
-
""" The red component of the vertex color. 0.0 <= r <= 1.0.
|
|
2925
|
-
|
|
2926
|
-
:type: float
|
|
2927
|
-
"""
|
|
2247
|
+
""" The red component of the vertex color. 0.0 <= r <= 1.0."""
|
|
2928
2248
|
|
|
2929
2249
|
g: float
|
|
2930
|
-
""" The green component of the vertex color. 0.0 <= g <= 1.0.
|
|
2931
|
-
|
|
2932
|
-
:type: float
|
|
2933
|
-
"""
|
|
2250
|
+
""" The green component of the vertex color. 0.0 <= g <= 1.0."""
|
|
2934
2251
|
|
|
2935
2252
|
b: float
|
|
2936
|
-
""" The blue component of the vertex color. 0.0 <= b <= 1.0.
|
|
2937
|
-
|
|
2938
|
-
:type: float
|
|
2939
|
-
"""
|
|
2253
|
+
""" The blue component of the vertex color. 0.0 <= b <= 1.0."""
|
|
2940
2254
|
|
|
2941
2255
|
a: float
|
|
2942
|
-
""" The alpha component of the vertex color. 0.0 <= a <= 1.0.
|
|
2943
|
-
|
|
2944
|
-
:type: float
|
|
2945
|
-
"""
|
|
2256
|
+
""" The alpha component of the vertex color. 0.0 <= a <= 1.0."""
|
|
2946
2257
|
|
|
2947
|
-
def getXYZ(self):
|
|
2258
|
+
def getXYZ(self) -> None:
|
|
2948
2259
|
"""Gets the position of this vertex.
|
|
2949
2260
|
|
|
2950
2261
|
:return: this vertexes position in local coordinates.
|
|
2951
2262
|
"""
|
|
2952
2263
|
|
|
2953
|
-
def
|
|
2954
|
-
"""Sets the position of this vertex.
|
|
2955
|
-
|
|
2956
|
-
:param pos: the new position for this vertex in local coordinates.
|
|
2957
|
-
"""
|
|
2958
|
-
|
|
2959
|
-
def getUV(self):
|
|
2264
|
+
def getUV(self) -> None:
|
|
2960
2265
|
"""Gets the UV (texture) coordinates of this vertex.
|
|
2961
2266
|
|
|
2962
2267
|
:return: this vertexes UV (texture) coordinates.
|
|
2963
2268
|
"""
|
|
2964
2269
|
|
|
2965
|
-
def
|
|
2966
|
-
"""Sets the UV (texture) coordinates of this vertex.
|
|
2967
|
-
|
|
2968
|
-
:param uv:
|
|
2969
|
-
"""
|
|
2970
|
-
|
|
2971
|
-
def getUV2(self):
|
|
2270
|
+
def getUV2(self) -> None:
|
|
2972
2271
|
"""Gets the 2nd UV (texture) coordinates of this vertex.
|
|
2973
2272
|
|
|
2974
2273
|
:return: this vertexes UV (texture) coordinates.
|
|
2975
2274
|
"""
|
|
2976
2275
|
|
|
2977
|
-
def setUV2(self, uv, unit):
|
|
2978
|
-
"""Sets the 2nd UV (texture) coordinates of this vertex.
|
|
2979
|
-
|
|
2980
|
-
:param uv:
|
|
2981
|
-
:param unit: optional argument, FLAT==1, SECOND_UV==2, defaults to SECOND_UVinteger
|
|
2982
|
-
"""
|
|
2983
|
-
|
|
2984
2276
|
def getRGBA(self) -> int:
|
|
2985
2277
|
"""Gets the color of this vertex.The color is represented as four bytes packed into an integer value. The color is
|
|
2986
2278
|
packed as RGBA.Since Python offers no way to get each byte without shifting, you must use the struct module to
|
|
2987
2279
|
access color in an machine independent way.Because of this, it is suggested you use the r, g, b and a attributes or the color attribute instead.
|
|
2988
2280
|
|
|
2989
2281
|
:return: packed color. 4 byte integer with one byte per color channel in RGBA format.
|
|
2990
|
-
:rtype: int
|
|
2991
|
-
"""
|
|
2992
|
-
|
|
2993
|
-
def setRGBA(self, col: int):
|
|
2994
|
-
"""Sets the color of this vertex.See getRGBA() for the format of col, and its relevant problems. Use the r, g, b and a attributes
|
|
2995
|
-
or the color attribute instead.setRGBA() also accepts a four component list as argument col. The list represents the color as [r, g, b, a]
|
|
2996
|
-
with black = [0.0, 0.0, 0.0, 1.0] and white = [1.0, 1.0, 1.0, 1.0]
|
|
2997
|
-
|
|
2998
|
-
:param col: the new color of this vertex in packed RGBA format.
|
|
2999
|
-
:type col: int
|
|
3000
2282
|
"""
|
|
3001
2283
|
|
|
3002
|
-
def getNormal(self):
|
|
2284
|
+
def getNormal(self) -> None:
|
|
3003
2285
|
"""Gets the normal vector of this vertex.
|
|
3004
2286
|
|
|
3005
2287
|
:return: normalized normal vector.
|
|
3006
2288
|
"""
|
|
3007
2289
|
|
|
3008
|
-
def setNormal(self, normal):
|
|
3009
|
-
"""Sets the normal vector of this vertex.
|
|
3010
|
-
|
|
3011
|
-
:param normal: the new normal of this vertex.
|
|
3012
|
-
"""
|
|
3013
|
-
|
|
3014
2290
|
class SCA_2DFilterActuator:
|
|
3015
|
-
"""Create, enable and disable 2D filters.The following properties
|
|
2291
|
+
"""Create, enable and disable 2D filters.The following properties dont have an immediate effect.
|
|
3016
2292
|
You must active the actuator to get the result.
|
|
3017
2293
|
The actuator is not persistent: it automatically stops itself after setting up the filter
|
|
3018
|
-
but the filter remains active. To stop a filter you must activate the actuator with
|
|
2294
|
+
but the filter remains active. To stop a filter you must activate the actuator with type
|
|
3019
2295
|
set to `~bge.logic.RAS_2DFILTER_DISABLED` or `~bge.logic.RAS_2DFILTER_NOFILTER`.action on motion blur: 0=enable, 1=disable.type
|
|
3020
2296
|
|
|
3021
2297
|
integer0.3.0argument for motion blur filter.type
|
|
@@ -3024,17 +2300,11 @@ class SCA_2DFilterActuator:
|
|
|
3024
2300
|
"""
|
|
3025
2301
|
|
|
3026
2302
|
shaderText: str
|
|
3027
|
-
""" shader source code for custom shader.
|
|
3028
|
-
|
|
3029
|
-
:type: str
|
|
3030
|
-
"""
|
|
2303
|
+
""" shader source code for custom shader."""
|
|
3031
2304
|
|
|
3032
2305
|
disableMotionBlur: typing.Any
|
|
3033
2306
|
mode: int
|
|
3034
|
-
""" Type of 2D filter, use one of `these constants <Two-D-FilterActuator-mode>`.
|
|
3035
|
-
|
|
3036
|
-
:type: int
|
|
3037
|
-
"""
|
|
2307
|
+
""" Type of 2D filter, use one of `these constants <Two-D-FilterActuator-mode>`."""
|
|
3038
2308
|
|
|
3039
2309
|
passNumber: typing.Any
|
|
3040
2310
|
""" order number of filter in the stack of 2D filters. Filters are executed in increasing order of passNb.Only be one filter can be defined per passNb."""
|
|
@@ -3048,65 +2318,35 @@ class SCA_ActionActuator:
|
|
|
3048
2318
|
"""Action Actuators apply an action to an actor."""
|
|
3049
2319
|
|
|
3050
2320
|
action: str
|
|
3051
|
-
""" The name of the action to set as the current action.
|
|
3052
|
-
|
|
3053
|
-
:type: str
|
|
3054
|
-
"""
|
|
2321
|
+
""" The name of the action to set as the current action."""
|
|
3055
2322
|
|
|
3056
2323
|
frameStart: float
|
|
3057
|
-
""" Specifies the starting frame of the animation.
|
|
3058
|
-
|
|
3059
|
-
:type: float
|
|
3060
|
-
"""
|
|
2324
|
+
""" Specifies the starting frame of the animation."""
|
|
3061
2325
|
|
|
3062
2326
|
frameEnd: float
|
|
3063
|
-
""" Specifies the ending frame of the animation.
|
|
3064
|
-
|
|
3065
|
-
:type: float
|
|
3066
|
-
"""
|
|
2327
|
+
""" Specifies the ending frame of the animation."""
|
|
3067
2328
|
|
|
3068
2329
|
blendIn: float
|
|
3069
|
-
""" Specifies the number of frames of animation to generate when making transitions between actions.
|
|
3070
|
-
|
|
3071
|
-
:type: float
|
|
3072
|
-
"""
|
|
2330
|
+
""" Specifies the number of frames of animation to generate when making transitions between actions."""
|
|
3073
2331
|
|
|
3074
2332
|
priority: int
|
|
3075
|
-
""" Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers.
|
|
3076
|
-
|
|
3077
|
-
:type: int
|
|
3078
|
-
"""
|
|
2333
|
+
""" Sets the priority of this actuator. Actuators will lower priority numbers will override actuators with higher numbers."""
|
|
3079
2334
|
|
|
3080
2335
|
frame: float
|
|
3081
|
-
""" Sets the current frame for the animation.
|
|
3082
|
-
|
|
3083
|
-
:type: float
|
|
3084
|
-
"""
|
|
2336
|
+
""" Sets the current frame for the animation."""
|
|
3085
2337
|
|
|
3086
2338
|
propName: str
|
|
3087
|
-
""" Sets the property to be used in FromProp playback mode.
|
|
3088
|
-
|
|
3089
|
-
:type: str
|
|
3090
|
-
"""
|
|
2339
|
+
""" Sets the property to be used in FromProp playback mode."""
|
|
3091
2340
|
|
|
3092
2341
|
mode: int
|
|
3093
|
-
""" The operation mode of the actuator. Can be one of `these constants<action-actuator>`.
|
|
3094
|
-
|
|
3095
|
-
:type: int
|
|
3096
|
-
"""
|
|
2342
|
+
""" The operation mode of the actuator. Can be one of `these constants<action-actuator>`."""
|
|
3097
2343
|
|
|
3098
2344
|
useContinue: bool
|
|
3099
2345
|
""" The actions continue option, True or False. When True, the action will always play from where last left off,
|
|
3100
|
-
otherwise negative events to this actuator will reset it to its start frame.
|
|
3101
|
-
|
|
3102
|
-
:type: bool
|
|
3103
|
-
"""
|
|
2346
|
+
otherwise negative events to this actuator will reset it to its start frame."""
|
|
3104
2347
|
|
|
3105
2348
|
framePropName: str
|
|
3106
|
-
""" The name of the property that is set to the current frame number.
|
|
3107
|
-
|
|
3108
|
-
:type: str
|
|
3109
|
-
"""
|
|
2349
|
+
""" The name of the property that is set to the current frame number."""
|
|
3110
2350
|
|
|
3111
2351
|
class SCA_ActuatorSensor:
|
|
3112
2352
|
"""Actuator sensor detect change in actuator state of the parent object.
|
|
@@ -3115,10 +2355,7 @@ class SCA_ActuatorSensor:
|
|
|
3115
2355
|
"""
|
|
3116
2356
|
|
|
3117
2357
|
actuator: str
|
|
3118
|
-
""" the name of the actuator that the sensor is monitoring.
|
|
3119
|
-
|
|
3120
|
-
:type: str
|
|
3121
|
-
"""
|
|
2358
|
+
""" the name of the actuator that the sensor is monitoring."""
|
|
3122
2359
|
|
|
3123
2360
|
class SCA_AddObjectActuator:
|
|
3124
2361
|
"""Edit Object Actuator (in Add Object Mode)"""
|
|
@@ -3130,10 +2367,7 @@ class SCA_AddObjectActuator:
|
|
|
3130
2367
|
""" the last added object from this actuator (read-only)."""
|
|
3131
2368
|
|
|
3132
2369
|
time: float
|
|
3133
|
-
""" the lifetime of added objects, in frames. Set to 0 to disable automatic deletion.
|
|
3134
|
-
|
|
3135
|
-
:type: float
|
|
3136
|
-
"""
|
|
2370
|
+
""" the lifetime of added objects, in frames. Set to 0 to disable automatic deletion."""
|
|
3137
2371
|
|
|
3138
2372
|
linearVelocity: typing.Any
|
|
3139
2373
|
""" the initial linear velocity of added objects."""
|
|
@@ -3141,7 +2375,7 @@ class SCA_AddObjectActuator:
|
|
|
3141
2375
|
angularVelocity: typing.Any
|
|
3142
2376
|
""" the initial angular velocity of added objects."""
|
|
3143
2377
|
|
|
3144
|
-
def instantAddObject(self):
|
|
2378
|
+
def instantAddObject(self) -> None:
|
|
3145
2379
|
"""adds the object without needing to calling SCA_PythonController.activate()"""
|
|
3146
2380
|
|
|
3147
2381
|
class SCA_AlwaysSensor:
|
|
@@ -3151,10 +2385,7 @@ class SCA_ArmatureActuator:
|
|
|
3151
2385
|
"""Armature Actuators change constraint condition on armatures."""
|
|
3152
2386
|
|
|
3153
2387
|
type: int
|
|
3154
|
-
""" The type of action that the actuator executes when it is active.Can be one of `these constants <armatureactuator-constants-type>`
|
|
3155
|
-
|
|
3156
|
-
:type: int
|
|
3157
|
-
"""
|
|
2388
|
+
""" The type of action that the actuator executes when it is active.Can be one of `these constants <armatureactuator-constants-type>`"""
|
|
3158
2389
|
|
|
3159
2390
|
constraint: typing.Any
|
|
3160
2391
|
""" The constraint object this actuator is controlling."""
|
|
@@ -3175,10 +2406,7 @@ class SCA_ArmatureSensor:
|
|
|
3175
2406
|
"""Armature sensor detect conditions on armatures."""
|
|
3176
2407
|
|
|
3177
2408
|
type: int
|
|
3178
|
-
""" The type of measurement that the sensor make when it is active.Can be one of `these constants <armaturesensor-type>`
|
|
3179
|
-
|
|
3180
|
-
:type: int
|
|
3181
|
-
"""
|
|
2409
|
+
""" The type of measurement that the sensor make when it is active.Can be one of `these constants <armaturesensor-type>`"""
|
|
3182
2410
|
|
|
3183
2411
|
constraint: typing.Any
|
|
3184
2412
|
""" The constraint object this sensor is watching."""
|
|
@@ -3189,43 +2417,25 @@ The linear error is only updated on CopyPose/Distance IK constraint with iTaSC s
|
|
|
3189
2417
|
The rotation error is only updated on CopyPose+rotation IK constraint with iTaSC solver
|
|
3190
2418
|
The linear error on CopyPose is always >= 0: it is the norm of the distance between the target and the bone
|
|
3191
2419
|
The rotation error on CopyPose is always >= 0: it is the norm of the equivalent rotation vector between the bone and the target orientations
|
|
3192
|
-
The linear error on Distance can be positive if the distance between the bone and the target is greater than the desired distance, and negative if the distance is smaller.
|
|
3193
|
-
|
|
3194
|
-
:type: float
|
|
3195
|
-
"""
|
|
2420
|
+
The linear error on Distance can be positive if the distance between the bone and the target is greater than the desired distance, and negative if the distance is smaller."""
|
|
3196
2421
|
|
|
3197
2422
|
class SCA_CameraActuator:
|
|
3198
2423
|
"""Applies changes to a camera."""
|
|
3199
2424
|
|
|
3200
2425
|
damping: float
|
|
3201
|
-
""" strength of of the camera following movement.
|
|
3202
|
-
|
|
3203
|
-
:type: float
|
|
3204
|
-
"""
|
|
2426
|
+
""" strength of of the camera following movement."""
|
|
3205
2427
|
|
|
3206
2428
|
axis: int
|
|
3207
|
-
""" The camera axis (0, 1, 2) for positive XYZ, (3, 4, 5) for negative XYZ.
|
|
3208
|
-
|
|
3209
|
-
:type: int
|
|
3210
|
-
"""
|
|
2429
|
+
""" The camera axis (0, 1, 2) for positive XYZ, (3, 4, 5) for negative XYZ."""
|
|
3211
2430
|
|
|
3212
2431
|
min: float
|
|
3213
|
-
""" minimum distance to the target object maintained by the actuator.
|
|
3214
|
-
|
|
3215
|
-
:type: float
|
|
3216
|
-
"""
|
|
2432
|
+
""" minimum distance to the target object maintained by the actuator."""
|
|
3217
2433
|
|
|
3218
2434
|
max: float
|
|
3219
|
-
""" maximum distance to stay from the target object.
|
|
3220
|
-
|
|
3221
|
-
:type: float
|
|
3222
|
-
"""
|
|
2435
|
+
""" maximum distance to stay from the target object."""
|
|
3223
2436
|
|
|
3224
2437
|
height: float
|
|
3225
|
-
""" height to stay above the target object.
|
|
3226
|
-
|
|
3227
|
-
:type: float
|
|
3228
|
-
"""
|
|
2438
|
+
""" height to stay above the target object."""
|
|
3229
2439
|
|
|
3230
2440
|
object: typing.Any
|
|
3231
2441
|
""" the object this actuator tracks."""
|
|
@@ -3234,22 +2444,13 @@ class SCA_CollisionSensor:
|
|
|
3234
2444
|
"""Collision sensor detects collisions between objects."""
|
|
3235
2445
|
|
|
3236
2446
|
propName: str
|
|
3237
|
-
""" The property or material to collide with.
|
|
3238
|
-
|
|
3239
|
-
:type: str
|
|
3240
|
-
"""
|
|
2447
|
+
""" The property or material to collide with."""
|
|
3241
2448
|
|
|
3242
2449
|
useMaterial: bool
|
|
3243
|
-
""" Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property.
|
|
3244
|
-
|
|
3245
|
-
:type: bool
|
|
3246
|
-
"""
|
|
2450
|
+
""" Determines if the sensor is looking for a property or material. KX_True = Find material; KX_False = Find property."""
|
|
3247
2451
|
|
|
3248
2452
|
usePulseCollision: bool
|
|
3249
|
-
""" When enabled, changes to the set of colliding objects generate a pulse.
|
|
3250
|
-
|
|
3251
|
-
:type: bool
|
|
3252
|
-
"""
|
|
2453
|
+
""" When enabled, changes to the set of colliding objects generate a pulse."""
|
|
3253
2454
|
|
|
3254
2455
|
hitObject: typing.Any
|
|
3255
2456
|
""" The last collided object. (read-only)."""
|
|
@@ -3258,76 +2459,43 @@ class SCA_CollisionSensor:
|
|
|
3258
2459
|
""" A list of colliding objects. (read-only)."""
|
|
3259
2460
|
|
|
3260
2461
|
hitMaterial: str
|
|
3261
|
-
""" The material of the object in the face hit by the ray. (read-only).
|
|
3262
|
-
|
|
3263
|
-
:type: str
|
|
3264
|
-
"""
|
|
2462
|
+
""" The material of the object in the face hit by the ray. (read-only)."""
|
|
3265
2463
|
|
|
3266
2464
|
class SCA_ConstraintActuator:
|
|
3267
2465
|
"""A constraint actuator limits the position, rotation, distance or orientation of an object."""
|
|
3268
2466
|
|
|
3269
2467
|
damp: int
|
|
3270
|
-
""" Time constant of the constraint expressed in frame (not use by Force field constraint).
|
|
3271
|
-
|
|
3272
|
-
:type: int
|
|
3273
|
-
"""
|
|
2468
|
+
""" Time constant of the constraint expressed in frame (not use by Force field constraint)."""
|
|
3274
2469
|
|
|
3275
2470
|
rotDamp: int
|
|
3276
|
-
""" Time constant for the rotation expressed in frame (only for the distance constraint), 0 = use damp for rotation as well.
|
|
3277
|
-
|
|
3278
|
-
:type: int
|
|
3279
|
-
"""
|
|
2471
|
+
""" Time constant for the rotation expressed in frame (only for the distance constraint), 0 = use damp for rotation as well."""
|
|
3280
2472
|
|
|
3281
2473
|
direction: typing.Any
|
|
3282
2474
|
""" The reference direction in world coordinate for the orientation constraint."""
|
|
3283
2475
|
|
|
3284
2476
|
option: int
|
|
3285
|
-
""" Binary combination of `these constants <constraint-actuator-option>`
|
|
3286
|
-
|
|
3287
|
-
:type: int
|
|
3288
|
-
"""
|
|
2477
|
+
""" Binary combination of `these constants <constraint-actuator-option>`"""
|
|
3289
2478
|
|
|
3290
2479
|
time: int
|
|
3291
|
-
""" activation time of the actuator. The actuator disables itself after this many frame. If set to 0, the actuator is not limited in time.
|
|
3292
|
-
|
|
3293
|
-
:type: int
|
|
3294
|
-
"""
|
|
2480
|
+
""" activation time of the actuator. The actuator disables itself after this many frame. If set to 0, the actuator is not limited in time."""
|
|
3295
2481
|
|
|
3296
2482
|
propName: str
|
|
3297
|
-
""" the name of the property or material for the ray detection of the distance constraint.
|
|
3298
|
-
|
|
3299
|
-
:type: str
|
|
3300
|
-
"""
|
|
2483
|
+
""" the name of the property or material for the ray detection of the distance constraint."""
|
|
3301
2484
|
|
|
3302
2485
|
min: float
|
|
3303
|
-
""" The lower bound of the constraint. For the rotation and orientation constraint, it represents radiant.
|
|
3304
|
-
|
|
3305
|
-
:type: float
|
|
3306
|
-
"""
|
|
2486
|
+
""" The lower bound of the constraint. For the rotation and orientation constraint, it represents radiant."""
|
|
3307
2487
|
|
|
3308
2488
|
distance: float
|
|
3309
|
-
""" the target distance of the distance constraint.
|
|
3310
|
-
|
|
3311
|
-
:type: float
|
|
3312
|
-
"""
|
|
2489
|
+
""" the target distance of the distance constraint."""
|
|
3313
2490
|
|
|
3314
2491
|
max: float
|
|
3315
|
-
""" the upper bound of the constraint. For rotation and orientation constraints, it represents radiant.
|
|
3316
|
-
|
|
3317
|
-
:type: float
|
|
3318
|
-
"""
|
|
2492
|
+
""" the upper bound of the constraint. For rotation and orientation constraints, it represents radiant."""
|
|
3319
2493
|
|
|
3320
2494
|
rayLength: float
|
|
3321
|
-
""" the length of the ray of the distance constraint.
|
|
3322
|
-
|
|
3323
|
-
:type: float
|
|
3324
|
-
"""
|
|
2495
|
+
""" the length of the ray of the distance constraint."""
|
|
3325
2496
|
|
|
3326
2497
|
limit: int
|
|
3327
|
-
""" type of constraint. Use one of the `these constants <constraint-actuator-limit>`
|
|
3328
|
-
|
|
3329
|
-
:type: int
|
|
3330
|
-
"""
|
|
2498
|
+
""" type of constraint. Use one of the `these constants <constraint-actuator-limit>`"""
|
|
3331
2499
|
|
|
3332
2500
|
class SCA_DelaySensor:
|
|
3333
2501
|
"""The Delay sensor generates positive and negative triggers at precise time,
|
|
@@ -3336,37 +2504,22 @@ class SCA_DelaySensor:
|
|
|
3336
2504
|
"""
|
|
3337
2505
|
|
|
3338
2506
|
delay: int
|
|
3339
|
-
""" length of the initial OFF period as number of frame, 0 for immediate trigger.
|
|
3340
|
-
|
|
3341
|
-
:type: int
|
|
3342
|
-
"""
|
|
2507
|
+
""" length of the initial OFF period as number of frame, 0 for immediate trigger."""
|
|
3343
2508
|
|
|
3344
2509
|
duration: int
|
|
3345
|
-
""" length of the ON period in number of frame after the initial OFF period.If duration is greater than 0, a negative trigger is sent at the end of the ON pulse.
|
|
3346
|
-
|
|
3347
|
-
:type: int
|
|
3348
|
-
"""
|
|
2510
|
+
""" length of the ON period in number of frame after the initial OFF period.If duration is greater than 0, a negative trigger is sent at the end of the ON pulse."""
|
|
3349
2511
|
|
|
3350
2512
|
repeat: int
|
|
3351
|
-
""" 1 if the OFF-ON cycle should be repeated indefinitely, 0 if it should run once.
|
|
3352
|
-
|
|
3353
|
-
:type: int
|
|
3354
|
-
"""
|
|
2513
|
+
""" 1 if the OFF-ON cycle should be repeated indefinitely, 0 if it should run once."""
|
|
3355
2514
|
|
|
3356
2515
|
class SCA_DynamicActuator:
|
|
3357
2516
|
"""Dynamic Actuator."""
|
|
3358
2517
|
|
|
3359
2518
|
mode: int
|
|
3360
|
-
""" the type of operation of the actuator, 0-4
|
|
3361
|
-
|
|
3362
|
-
:type: int
|
|
3363
|
-
"""
|
|
2519
|
+
""" the type of operation of the actuator, 0-4"""
|
|
3364
2520
|
|
|
3365
2521
|
mass: float
|
|
3366
|
-
""" the mass value for the KX_DYN_SET_MASS operation.
|
|
3367
|
-
|
|
3368
|
-
:type: float
|
|
3369
|
-
"""
|
|
2522
|
+
""" the mass value for the KX_DYN_SET_MASS operation."""
|
|
3370
2523
|
|
|
3371
2524
|
class SCA_EndObjectActuator:
|
|
3372
2525
|
"""Edit Object Actuator (in End Object mode)This actuator has no python methods."""
|
|
@@ -3375,10 +2528,7 @@ class SCA_GameActuator:
|
|
|
3375
2528
|
"""The game actuator loads a new .blend file, restarts the current .blend file or quits the game."""
|
|
3376
2529
|
|
|
3377
2530
|
fileName: str
|
|
3378
|
-
""" the new .blend file to load.
|
|
3379
|
-
|
|
3380
|
-
:type: str
|
|
3381
|
-
"""
|
|
2531
|
+
""" the new .blend file to load."""
|
|
3382
2532
|
|
|
3383
2533
|
mode: typing.Any
|
|
3384
2534
|
""" The mode of this actuator. Can be on of `these constants <game-actuator>`"""
|
|
@@ -3399,28 +2549,19 @@ class SCA_IController:
|
|
|
3399
2549
|
""" A list of actuators linked to this controller."""
|
|
3400
2550
|
|
|
3401
2551
|
useHighPriority: bool
|
|
3402
|
-
""" When set the controller executes always before all other controllers that dont have this set.
|
|
3403
|
-
|
|
3404
|
-
:type: bool
|
|
3405
|
-
"""
|
|
2552
|
+
""" When set the controller executes always before all other controllers that dont have this set."""
|
|
3406
2553
|
|
|
3407
2554
|
class SCA_ILogicBrick:
|
|
3408
2555
|
"""Base class for all logic bricks."""
|
|
3409
2556
|
|
|
3410
2557
|
executePriority: int
|
|
3411
|
-
""" This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first).
|
|
3412
|
-
|
|
3413
|
-
:type: int
|
|
3414
|
-
"""
|
|
2558
|
+
""" This determines the order controllers are evaluated, and actuators are activated (lower priority is executed first)."""
|
|
3415
2559
|
|
|
3416
2560
|
owner: typing.Any
|
|
3417
2561
|
""" The game object this logic brick is attached to (read-only)."""
|
|
3418
2562
|
|
|
3419
2563
|
name: str
|
|
3420
|
-
""" The name of this logic brick (read-only).
|
|
3421
|
-
|
|
3422
|
-
:type: str
|
|
3423
|
-
"""
|
|
2564
|
+
""" The name of this logic brick (read-only)."""
|
|
3424
2565
|
|
|
3425
2566
|
class SCA_IObject:
|
|
3426
2567
|
"""This class has no python functions"""
|
|
@@ -3429,28 +2570,16 @@ class SCA_ISensor:
|
|
|
3429
2570
|
"""Base class for all sensor logic bricks."""
|
|
3430
2571
|
|
|
3431
2572
|
usePosPulseMode: bool
|
|
3432
|
-
""" Flag to turn positive pulse mode on and off.
|
|
3433
|
-
|
|
3434
|
-
:type: bool
|
|
3435
|
-
"""
|
|
2573
|
+
""" Flag to turn positive pulse mode on and off."""
|
|
3436
2574
|
|
|
3437
2575
|
useNegPulseMode: bool
|
|
3438
|
-
""" Flag to turn negative pulse mode on and off.
|
|
3439
|
-
|
|
3440
|
-
:type: bool
|
|
3441
|
-
"""
|
|
2576
|
+
""" Flag to turn negative pulse mode on and off."""
|
|
3442
2577
|
|
|
3443
2578
|
frequency: int
|
|
3444
|
-
""" The frequency for pulse mode sensors.Use `skippedTicks`0.0.1
|
|
3445
|
-
|
|
3446
|
-
:type: int
|
|
3447
|
-
"""
|
|
2579
|
+
""" The frequency for pulse mode sensors.Use `skippedTicks`0.0.1"""
|
|
3448
2580
|
|
|
3449
2581
|
skippedTicks: int
|
|
3450
|
-
""" Number of logic ticks skipped between 2 active pulses
|
|
3451
|
-
|
|
3452
|
-
:type: int
|
|
3453
|
-
"""
|
|
2582
|
+
""" Number of logic ticks skipped between 2 active pulses"""
|
|
3454
2583
|
|
|
3455
2584
|
level: bool
|
|
3456
2585
|
""" level Option whether to detect level or edge transition when entering a state.
|
|
@@ -3458,57 +2587,33 @@ It makes a difference only in case of logic state transition (state actuator).
|
|
|
3458
2587
|
A level detector will immediately generate a pulse, negative or positive
|
|
3459
2588
|
depending on the sensor condition, as soon as the state is activated.
|
|
3460
2589
|
A edge detector will wait for a state change before generating a pulse.
|
|
3461
|
-
note: mutually exclusive with `tap`, enabling will disable `tap`.
|
|
3462
|
-
|
|
3463
|
-
:type: bool
|
|
3464
|
-
"""
|
|
2590
|
+
note: mutually exclusive with `tap`, enabling will disable `tap`."""
|
|
3465
2591
|
|
|
3466
2592
|
tap: bool
|
|
3467
2593
|
""" When enabled only sensors that are just activated will send a positive event,
|
|
3468
2594
|
after this they will be detected as negative by the controllers.
|
|
3469
2595
|
This will make a key that's held act as if its only tapped for an instant.
|
|
3470
|
-
note: mutually exclusive with `level`, enabling will disable `level`.
|
|
3471
|
-
|
|
3472
|
-
:type: bool
|
|
3473
|
-
"""
|
|
2596
|
+
note: mutually exclusive with `level`, enabling will disable `level`."""
|
|
3474
2597
|
|
|
3475
2598
|
invert: bool
|
|
3476
|
-
""" Flag to set if this sensor activates on positive or negative events.
|
|
3477
|
-
|
|
3478
|
-
:type: bool
|
|
3479
|
-
"""
|
|
2599
|
+
""" Flag to set if this sensor activates on positive or negative events."""
|
|
3480
2600
|
|
|
3481
2601
|
triggered: bool
|
|
3482
|
-
""" True if this sensor brick is in a positive state. (read-only).
|
|
3483
|
-
|
|
3484
|
-
:type: bool
|
|
3485
|
-
"""
|
|
2602
|
+
""" True if this sensor brick is in a positive state. (read-only)."""
|
|
3486
2603
|
|
|
3487
2604
|
positive: bool
|
|
3488
|
-
""" True if this sensor brick is in a positive state. (read-only).
|
|
3489
|
-
|
|
3490
|
-
:type: bool
|
|
3491
|
-
"""
|
|
2605
|
+
""" True if this sensor brick is in a positive state. (read-only)."""
|
|
3492
2606
|
|
|
3493
2607
|
pos_ticks: int
|
|
3494
|
-
""" The number of ticks since the last positive pulse (read-only).
|
|
3495
|
-
|
|
3496
|
-
:type: int
|
|
3497
|
-
"""
|
|
2608
|
+
""" The number of ticks since the last positive pulse (read-only)."""
|
|
3498
2609
|
|
|
3499
2610
|
neg_ticks: int
|
|
3500
|
-
""" The number of ticks since the last negative pulse (read-only).
|
|
3501
|
-
|
|
3502
|
-
:type: int
|
|
3503
|
-
"""
|
|
2611
|
+
""" The number of ticks since the last negative pulse (read-only)."""
|
|
3504
2612
|
|
|
3505
2613
|
status: int
|
|
3506
|
-
""" The status of the sensor (read-only): can be one of `these constants<sensor-status>`.
|
|
3507
|
-
|
|
3508
|
-
:type: int
|
|
3509
|
-
"""
|
|
2614
|
+
""" The status of the sensor (read-only): can be one of `these constants<sensor-status>`."""
|
|
3510
2615
|
|
|
3511
|
-
def reset(self):
|
|
2616
|
+
def reset(self) -> None:
|
|
3512
2617
|
"""Reset sensor internal state, effect depends on the type of sensor and settings.The sensor is put in its initial state as if it was just activated."""
|
|
3513
2618
|
|
|
3514
2619
|
class SCA_InputEvent:
|
|
@@ -3518,201 +2623,114 @@ class SCA_InputEvent:
|
|
|
3518
2623
|
""" A list of existing status of the input from the last frame.
|
|
3519
2624
|
Can contain `bge.logic.KX_INPUT_NONE` and `bge.logic.KX_INPUT_ACTIVE`.
|
|
3520
2625
|
The list always contains one value.
|
|
3521
|
-
The first value of the list is the last value of the list in the last frame. (read-only)
|
|
3522
|
-
|
|
3523
|
-
:type: list[int]
|
|
3524
|
-
"""
|
|
2626
|
+
The first value of the list is the last value of the list in the last frame. (read-only)"""
|
|
3525
2627
|
|
|
3526
2628
|
queue: list[int]
|
|
3527
2629
|
""" A list of existing events of the input from the last frame.
|
|
3528
2630
|
Can contain `bge.logic.KX_INPUT_JUST_ACTIVATED` and `bge.logic.KX_INPUT_JUST_RELEASED`.
|
|
3529
|
-
The list can be empty. (read-only)
|
|
3530
|
-
|
|
3531
|
-
:type: list[int]
|
|
3532
|
-
"""
|
|
2631
|
+
The list can be empty. (read-only)"""
|
|
3533
2632
|
|
|
3534
2633
|
values: list[int]
|
|
3535
2634
|
""" A list of existing value of the input from the last frame.
|
|
3536
2635
|
For keyboard it contains 1 or 0 and for mouse the coordinate of the mouse or the movement of the wheel mouse.
|
|
3537
2636
|
The list contains always one value, the size of the list is the same than `queue` + 1 only for keyboard inputs.
|
|
3538
|
-
The first value of the list is the last value of the list in the last frame. (read-only)Example to get the non-normalized mouse coordinates:
|
|
3539
|
-
|
|
3540
|
-
:type: list[int]
|
|
3541
|
-
"""
|
|
2637
|
+
The first value of the list is the last value of the list in the last frame. (read-only)Example to get the non-normalized mouse coordinates:"""
|
|
3542
2638
|
|
|
3543
2639
|
inactive: bool
|
|
3544
|
-
""" True if the input was inactive from the last frame.
|
|
3545
|
-
|
|
3546
|
-
:type: bool
|
|
3547
|
-
"""
|
|
2640
|
+
""" True if the input was inactive from the last frame."""
|
|
3548
2641
|
|
|
3549
2642
|
active: bool
|
|
3550
|
-
""" True if the input was active from the last frame.
|
|
3551
|
-
|
|
3552
|
-
:type: bool
|
|
3553
|
-
"""
|
|
2643
|
+
""" True if the input was active from the last frame."""
|
|
3554
2644
|
|
|
3555
2645
|
activated: bool
|
|
3556
|
-
""" True if the input was activated from the last frame.
|
|
3557
|
-
|
|
3558
|
-
:type: bool
|
|
3559
|
-
"""
|
|
2646
|
+
""" True if the input was activated from the last frame."""
|
|
3560
2647
|
|
|
3561
2648
|
released: bool
|
|
3562
|
-
""" True if the input was released from the last frame.Example to execute some action when I click or release mouse left button:
|
|
3563
|
-
|
|
3564
|
-
:type: bool
|
|
3565
|
-
"""
|
|
2649
|
+
""" True if the input was released from the last frame.Example to execute some action when I click or release mouse left button:"""
|
|
3566
2650
|
|
|
3567
2651
|
type: int
|
|
3568
2652
|
""" The type of the input.
|
|
3569
|
-
One of `these constants<keyboard-keys>`
|
|
3570
|
-
|
|
3571
|
-
:type: int
|
|
3572
|
-
"""
|
|
2653
|
+
One of `these constants<keyboard-keys>`"""
|
|
3573
2654
|
|
|
3574
2655
|
class SCA_JoystickSensor:
|
|
3575
2656
|
"""This sensor detects player joystick events."""
|
|
3576
2657
|
|
|
3577
2658
|
axisValues: list[int]
|
|
3578
2659
|
""" The state of the joysticks axis as a list of values `numAxis` long. (read-only).Each specifying the value of an axis between -32767 and 32767 depending on how far the axis is pushed, 0 for nothing.
|
|
3579
|
-
The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitrary controls.
|
|
3580
|
-
|
|
3581
|
-
:type: list[int]
|
|
3582
|
-
"""
|
|
2660
|
+
The first 2 values are used by most joysticks and gamepads for directional control. 3rd and 4th values are only on some joysticks and can be used for arbitrary controls."""
|
|
3583
2661
|
|
|
3584
2662
|
axisSingle: int
|
|
3585
|
-
""" like `axisValues` but returns a single axis value that is set by the sensor. (read-only).
|
|
3586
|
-
|
|
3587
|
-
:type: int
|
|
3588
|
-
"""
|
|
2663
|
+
""" like `axisValues` but returns a single axis value that is set by the sensor. (read-only)."""
|
|
3589
2664
|
|
|
3590
2665
|
hatValues: list[int]
|
|
3591
|
-
""" The state of the joysticks hats as a list of values `numHats` long. (read-only).Each specifying the direction of the hat from 1 to 12, 0 when inactive.Hat directions are as follows...Use `button` instead.0.2.2
|
|
3592
|
-
|
|
3593
|
-
:type: list[int]
|
|
3594
|
-
"""
|
|
2666
|
+
""" The state of the joysticks hats as a list of values `numHats` long. (read-only).Each specifying the direction of the hat from 1 to 12, 0 when inactive.Hat directions are as follows...Use `button` instead.0.2.2"""
|
|
3595
2667
|
|
|
3596
2668
|
hatSingle: int
|
|
3597
|
-
""" Like `hatValues` but returns a single hat direction value that is set by the sensor. (read-only).Use `button` instead.0.2.2
|
|
3598
|
-
|
|
3599
|
-
:type: int
|
|
3600
|
-
"""
|
|
2669
|
+
""" Like `hatValues` but returns a single hat direction value that is set by the sensor. (read-only).Use `button` instead.0.2.2"""
|
|
3601
2670
|
|
|
3602
2671
|
numAxis: int
|
|
3603
|
-
""" The number of axes for the joystick at this index. (read-only).
|
|
3604
|
-
|
|
3605
|
-
:type: int
|
|
3606
|
-
"""
|
|
2672
|
+
""" The number of axes for the joystick at this index. (read-only)."""
|
|
3607
2673
|
|
|
3608
2674
|
numButtons: int
|
|
3609
|
-
""" The number of buttons for the joystick at this index. (read-only).
|
|
3610
|
-
|
|
3611
|
-
:type: int
|
|
3612
|
-
"""
|
|
2675
|
+
""" The number of buttons for the joystick at this index. (read-only)."""
|
|
3613
2676
|
|
|
3614
2677
|
numHats: int
|
|
3615
|
-
""" The number of hats for the joystick at this index. (read-only).Use `numButtons` instead.0.2.2
|
|
3616
|
-
|
|
3617
|
-
:type: int
|
|
3618
|
-
"""
|
|
2678
|
+
""" The number of hats for the joystick at this index. (read-only).Use `numButtons` instead.0.2.2"""
|
|
3619
2679
|
|
|
3620
2680
|
connected: bool
|
|
3621
|
-
""" True if a joystick is connected at this joysticks index. (read-only).
|
|
3622
|
-
|
|
3623
|
-
:type: bool
|
|
3624
|
-
"""
|
|
2681
|
+
""" True if a joystick is connected at this joysticks index. (read-only)."""
|
|
3625
2682
|
|
|
3626
2683
|
index: int
|
|
3627
|
-
""" The joystick index to use (from 0 to 7). The first joystick is always 0.
|
|
3628
|
-
|
|
3629
|
-
:type: int
|
|
3630
|
-
"""
|
|
2684
|
+
""" The joystick index to use (from 0 to 7). The first joystick is always 0."""
|
|
3631
2685
|
|
|
3632
2686
|
threshold: int
|
|
3633
|
-
""" Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive.
|
|
3634
|
-
|
|
3635
|
-
:type: int
|
|
3636
|
-
"""
|
|
2687
|
+
""" Axis threshold. Joystick axis motion below this threshold wont trigger an event. Use values between (0 and 32767), lower values are more sensitive."""
|
|
3637
2688
|
|
|
3638
2689
|
button: int
|
|
3639
|
-
""" The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect.
|
|
3640
|
-
|
|
3641
|
-
:type: int
|
|
3642
|
-
"""
|
|
2690
|
+
""" The button index the sensor reacts to (first button = 0). When the "All Events" toggle is set, this option has no effect."""
|
|
3643
2691
|
|
|
3644
2692
|
axis: [int, int]
|
|
3645
|
-
""" The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection]
|
|
3646
|
-
|
|
3647
|
-
:type: [int, int]
|
|
3648
|
-
"""
|
|
2693
|
+
""" The axis this sensor reacts to, as a list of two values [axisIndex, axisDirection]"""
|
|
3649
2694
|
|
|
3650
2695
|
hat: [int, int]
|
|
3651
|
-
""" The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]Use `button` instead.0.2.2
|
|
3652
|
-
|
|
3653
|
-
:type: [int, int]
|
|
3654
|
-
"""
|
|
2696
|
+
""" The hat the sensor reacts to, as a list of two values: [hatIndex, hatDirection]Use `button` instead.0.2.2"""
|
|
3655
2697
|
|
|
3656
2698
|
def getButtonActiveList(self) -> list:
|
|
3657
2699
|
"""
|
|
3658
2700
|
|
|
3659
2701
|
:return: A list containing the indicies of the currently pressed buttons.
|
|
3660
|
-
:rtype: list
|
|
3661
2702
|
"""
|
|
3662
2703
|
|
|
3663
2704
|
def getButtonStatus(self, buttonIndex: int) -> bool:
|
|
3664
2705
|
"""
|
|
3665
2706
|
|
|
3666
2707
|
:param buttonIndex: the button index, 0=first button
|
|
3667
|
-
:type buttonIndex: int
|
|
3668
2708
|
:return: The current pressed state of the specified button.
|
|
3669
|
-
:rtype: bool
|
|
3670
2709
|
"""
|
|
3671
2710
|
|
|
3672
2711
|
class SCA_KeyboardSensor:
|
|
3673
2712
|
"""A keyboard sensor detects player key presses.See module `bge.events` for keycode values."""
|
|
3674
2713
|
|
|
3675
2714
|
key: int
|
|
3676
|
-
""" The key code this sensor is looking for. Expects a keycode from `bge.events` module.
|
|
3677
|
-
|
|
3678
|
-
:type: int
|
|
3679
|
-
"""
|
|
2715
|
+
""" The key code this sensor is looking for. Expects a keycode from `bge.events` module."""
|
|
3680
2716
|
|
|
3681
2717
|
hold1: int
|
|
3682
|
-
""" The key code for the first modifier this sensor is looking for. Expects a keycode from `bge.events` module.
|
|
3683
|
-
|
|
3684
|
-
:type: int
|
|
3685
|
-
"""
|
|
2718
|
+
""" The key code for the first modifier this sensor is looking for. Expects a keycode from `bge.events` module."""
|
|
3686
2719
|
|
|
3687
2720
|
hold2: int
|
|
3688
|
-
""" The key code for the second modifier this sensor is looking for. Expects a keycode from `bge.events` module.
|
|
3689
|
-
|
|
3690
|
-
:type: int
|
|
3691
|
-
"""
|
|
2721
|
+
""" The key code for the second modifier this sensor is looking for. Expects a keycode from `bge.events` module."""
|
|
3692
2722
|
|
|
3693
2723
|
toggleProperty: str
|
|
3694
|
-
""" The name of the property that indicates whether or not to log keystrokes as a string.
|
|
3695
|
-
|
|
3696
|
-
:type: str
|
|
3697
|
-
"""
|
|
2724
|
+
""" The name of the property that indicates whether or not to log keystrokes as a string."""
|
|
3698
2725
|
|
|
3699
2726
|
targetProperty: str
|
|
3700
|
-
""" The name of the property that receives keystrokes in case in case a string is logged.
|
|
3701
|
-
|
|
3702
|
-
:type: str
|
|
3703
|
-
"""
|
|
2727
|
+
""" The name of the property that receives keystrokes in case in case a string is logged."""
|
|
3704
2728
|
|
|
3705
2729
|
useAllKeys: bool
|
|
3706
|
-
""" Flag to determine whether or not to accept all keys.
|
|
3707
|
-
|
|
3708
|
-
:type: bool
|
|
3709
|
-
"""
|
|
2730
|
+
""" Flag to determine whether or not to accept all keys."""
|
|
3710
2731
|
|
|
3711
2732
|
inputs: dict
|
|
3712
|
-
""" A list of pressed input keys that have either been pressed, or just released, or are active this frame. (read-only).
|
|
3713
|
-
|
|
3714
|
-
:type: dict
|
|
3715
|
-
"""
|
|
2733
|
+
""" A list of pressed input keys that have either been pressed, or just released, or are active this frame. (read-only)."""
|
|
3716
2734
|
|
|
3717
2735
|
events: typing.Any
|
|
3718
2736
|
""" a list of pressed keys that have either been pressed, or just released, or are active this frame. (read-only).Use `inputs`0.2.2"""
|
|
@@ -3721,61 +2739,38 @@ class SCA_KeyboardSensor:
|
|
|
3721
2739
|
"""Get the status of a key.
|
|
3722
2740
|
|
|
3723
2741
|
:param keycode: The code that represents the key you want to get the state of, use one of `these constants<keyboard-keys>`
|
|
3724
|
-
:type keycode: int
|
|
3725
2742
|
:return: The state of the given key, can be one of `these constants<input-status>`
|
|
3726
|
-
:rtype: int
|
|
3727
2743
|
"""
|
|
3728
2744
|
|
|
3729
2745
|
class SCA_MouseActuator:
|
|
3730
2746
|
"""The mouse actuator gives control over the visibility of the mouse cursor and rotates the parent object according to mouse movement."""
|
|
3731
2747
|
|
|
3732
2748
|
visible: bool
|
|
3733
|
-
""" The visibility of the mouse cursor.
|
|
3734
|
-
|
|
3735
|
-
:type: bool
|
|
3736
|
-
"""
|
|
2749
|
+
""" The visibility of the mouse cursor."""
|
|
3737
2750
|
|
|
3738
2751
|
use_axis_x: bool
|
|
3739
|
-
""" Mouse movement along the x axis effects object rotation.
|
|
3740
|
-
|
|
3741
|
-
:type: bool
|
|
3742
|
-
"""
|
|
2752
|
+
""" Mouse movement along the x axis effects object rotation."""
|
|
3743
2753
|
|
|
3744
2754
|
use_axis_y: bool
|
|
3745
|
-
""" Mouse movement along the y axis effects object rotation.
|
|
3746
|
-
|
|
3747
|
-
:type: bool
|
|
3748
|
-
"""
|
|
2755
|
+
""" Mouse movement along the y axis effects object rotation."""
|
|
3749
2756
|
|
|
3750
2757
|
threshold: typing.Any
|
|
3751
2758
|
""" Amount of movement from the mouse required before rotation is triggered.The values in the list should be between 0.0 and 0.5."""
|
|
3752
2759
|
|
|
3753
2760
|
reset_x: bool
|
|
3754
|
-
""" Mouse is locked to the center of the screen on the x axis.
|
|
3755
|
-
|
|
3756
|
-
:type: bool
|
|
3757
|
-
"""
|
|
2761
|
+
""" Mouse is locked to the center of the screen on the x axis."""
|
|
3758
2762
|
|
|
3759
2763
|
reset_y: bool
|
|
3760
|
-
""" Mouse is locked to the center of the screen on the y axis.
|
|
3761
|
-
|
|
3762
|
-
:type: bool
|
|
3763
|
-
"""
|
|
2764
|
+
""" Mouse is locked to the center of the screen on the y axis."""
|
|
3764
2765
|
|
|
3765
2766
|
object_axis: typing.Any
|
|
3766
2767
|
""" The object's 3D axis to rotate with the mouse movement. ([x, y])"""
|
|
3767
2768
|
|
|
3768
2769
|
local_x: bool
|
|
3769
|
-
""" Rotation caused by mouse movement along the x axis is local.
|
|
3770
|
-
|
|
3771
|
-
:type: bool
|
|
3772
|
-
"""
|
|
2770
|
+
""" Rotation caused by mouse movement along the x axis is local."""
|
|
3773
2771
|
|
|
3774
2772
|
local_y: bool
|
|
3775
|
-
""" Rotation caused by mouse movement along the y axis is local.
|
|
3776
|
-
|
|
3777
|
-
:type: bool
|
|
3778
|
-
"""
|
|
2773
|
+
""" Rotation caused by mouse movement along the y axis is local."""
|
|
3779
2774
|
|
|
3780
2775
|
sensitivity: typing.Any
|
|
3781
2776
|
""" The amount of rotation caused by mouse movement along the x and y axis.Negative values invert the rotation."""
|
|
@@ -3791,7 +2786,7 @@ limit_y[0] is minimum, limit_y[1] is maximum."""
|
|
|
3791
2786
|
angle: typing.Any
|
|
3792
2787
|
""" The current rotational offset caused by the mouse actuator in degrees."""
|
|
3793
2788
|
|
|
3794
|
-
def reset(self):
|
|
2789
|
+
def reset(self) -> None:
|
|
3795
2790
|
"""Undoes the rotation caused by the mouse actuator."""
|
|
3796
2791
|
|
|
3797
2792
|
class SCA_MouseFocusSensor:
|
|
@@ -3821,55 +2816,30 @@ class SCA_MouseFocusSensor:
|
|
|
3821
2816
|
""" the UV coordinates at the point of intersection.If the object has no UV mapping, it returns [0, 0].The UV coordinates are not normalized, they can be < 0 or > 1 depending on the UV mapping."""
|
|
3822
2817
|
|
|
3823
2818
|
usePulseFocus: bool
|
|
3824
|
-
""" When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set).
|
|
3825
|
-
|
|
3826
|
-
:type: bool
|
|
3827
|
-
"""
|
|
2819
|
+
""" When enabled, moving the mouse over a different object generates a pulse. (only used when the 'Mouse Over Any' sensor option is set)."""
|
|
3828
2820
|
|
|
3829
2821
|
useXRay: bool
|
|
3830
|
-
"""
|
|
3831
|
-
|
|
3832
|
-
:type: bool
|
|
3833
|
-
"""
|
|
3834
|
-
|
|
3835
2822
|
mask: typing.Any
|
|
3836
2823
|
""" The collision mask (16 layers mapped to a 16-bit integer) combined with each object's collision group, to hit only a subset of the
|
|
3837
2824
|
objects in the scene. Only those objects for which collisionGroup & mask is true can be hit."""
|
|
3838
2825
|
|
|
3839
2826
|
propName: str
|
|
3840
|
-
"""
|
|
3841
|
-
|
|
3842
|
-
:type: str
|
|
3843
|
-
"""
|
|
3844
|
-
|
|
3845
2827
|
useMaterial: bool
|
|
3846
|
-
"""
|
|
3847
|
-
|
|
3848
|
-
:type: bool
|
|
3849
|
-
"""
|
|
3850
2828
|
|
|
3851
2829
|
class SCA_MouseSensor:
|
|
3852
2830
|
"""Mouse Sensor logic brick."""
|
|
3853
2831
|
|
|
3854
2832
|
position: [int, int]
|
|
3855
|
-
""" current [x, y] coordinates of the mouse, in frame coordinates (pixels).
|
|
3856
|
-
|
|
3857
|
-
:type: [int, int]
|
|
3858
|
-
"""
|
|
2833
|
+
""" current [x, y] coordinates of the mouse, in frame coordinates (pixels)."""
|
|
3859
2834
|
|
|
3860
2835
|
mode: int
|
|
3861
|
-
""" sensor mode. one of the following constants:
|
|
3862
|
-
|
|
3863
|
-
:type: int
|
|
3864
|
-
"""
|
|
2836
|
+
""" sensor mode. one of the following constants:"""
|
|
3865
2837
|
|
|
3866
2838
|
def getButtonStatus(self, button: int) -> int:
|
|
3867
2839
|
"""Get the mouse button status.
|
|
3868
2840
|
|
|
3869
2841
|
:param button: The code that represents the key you want to get the state of, use one of `these constants<mouse-keys>`
|
|
3870
|
-
:type button: int
|
|
3871
2842
|
:return: The state of the given key, can be one of `these constants<input-status>`
|
|
3872
|
-
:rtype: int
|
|
3873
2843
|
"""
|
|
3874
2844
|
|
|
3875
2845
|
class SCA_NANDController:
|
|
@@ -3882,70 +2852,40 @@ class SCA_NearSensor:
|
|
|
3882
2852
|
"""A near sensor is a specialised form of touch sensor."""
|
|
3883
2853
|
|
|
3884
2854
|
distance: float
|
|
3885
|
-
""" The near sensor activates when an object is within this distance.
|
|
3886
|
-
|
|
3887
|
-
:type: float
|
|
3888
|
-
"""
|
|
2855
|
+
""" The near sensor activates when an object is within this distance."""
|
|
3889
2856
|
|
|
3890
2857
|
resetDistance: float
|
|
3891
|
-
""" The near sensor deactivates when the object exceeds this distance.
|
|
3892
|
-
|
|
3893
|
-
:type: float
|
|
3894
|
-
"""
|
|
2858
|
+
""" The near sensor deactivates when the object exceeds this distance."""
|
|
3895
2859
|
|
|
3896
2860
|
class SCA_NetworkMessageActuator:
|
|
3897
2861
|
"""Message Actuator"""
|
|
3898
2862
|
|
|
3899
2863
|
propName: str
|
|
3900
|
-
""" Messages will only be sent to objects with the given property name.
|
|
3901
|
-
|
|
3902
|
-
:type: str
|
|
3903
|
-
"""
|
|
2864
|
+
""" Messages will only be sent to objects with the given property name."""
|
|
3904
2865
|
|
|
3905
2866
|
subject: str
|
|
3906
|
-
""" The subject field of the message.
|
|
3907
|
-
|
|
3908
|
-
:type: str
|
|
3909
|
-
"""
|
|
2867
|
+
""" The subject field of the message."""
|
|
3910
2868
|
|
|
3911
2869
|
body: str
|
|
3912
|
-
""" The body of the message.
|
|
3913
|
-
|
|
3914
|
-
:type: str
|
|
3915
|
-
"""
|
|
2870
|
+
""" The body of the message."""
|
|
3916
2871
|
|
|
3917
2872
|
usePropBody: bool
|
|
3918
|
-
""" Send a property instead of a regular body message.
|
|
3919
|
-
|
|
3920
|
-
:type: bool
|
|
3921
|
-
"""
|
|
2873
|
+
""" Send a property instead of a regular body message."""
|
|
3922
2874
|
|
|
3923
2875
|
class SCA_NetworkMessageSensor:
|
|
3924
2876
|
"""The Message Sensor logic brick.Currently only loopback (local) networks are supported."""
|
|
3925
2877
|
|
|
3926
2878
|
subject: str
|
|
3927
|
-
""" The subject the sensor is looking for.
|
|
3928
|
-
|
|
3929
|
-
:type: str
|
|
3930
|
-
"""
|
|
2879
|
+
""" The subject the sensor is looking for."""
|
|
3931
2880
|
|
|
3932
2881
|
frameMessageCount: int
|
|
3933
|
-
""" The number of messages received since the last frame. (read-only).
|
|
3934
|
-
|
|
3935
|
-
:type: int
|
|
3936
|
-
"""
|
|
2882
|
+
""" The number of messages received since the last frame. (read-only)."""
|
|
3937
2883
|
|
|
3938
2884
|
subjects: list[str]
|
|
3939
|
-
""" The list of message subjects received. (read-only).
|
|
3940
|
-
|
|
3941
|
-
:type: list[str]
|
|
3942
|
-
"""
|
|
2885
|
+
""" The list of message subjects received. (read-only)."""
|
|
3943
2886
|
|
|
3944
2887
|
bodies: list[str]
|
|
3945
|
-
""" The list of message bodies received. (read-only).
|
|
3946
|
-
|
|
3947
|
-
:type: list[str]
|
|
3948
|
-
"""
|
|
2888
|
+
""" The list of message bodies received. (read-only)."""
|
|
3949
2889
|
|
|
3950
2890
|
class SCA_ORController:
|
|
3951
2891
|
"""An OR controller activates when any connected sensor activates.There are no special python methods for this controller."""
|
|
@@ -3960,55 +2900,37 @@ class SCA_ObjectActuator:
|
|
|
3960
2900
|
""" The force applied by the actuator."""
|
|
3961
2901
|
|
|
3962
2902
|
useLocalForce: bool
|
|
3963
|
-
""" A flag specifying if the force is local.
|
|
3964
|
-
|
|
3965
|
-
:type: bool
|
|
3966
|
-
"""
|
|
2903
|
+
""" A flag specifying if the force is local."""
|
|
3967
2904
|
|
|
3968
2905
|
torque: typing.Any
|
|
3969
2906
|
""" The torque applied by the actuator."""
|
|
3970
2907
|
|
|
3971
2908
|
useLocalTorque: bool
|
|
3972
|
-
""" A flag specifying if the torque is local.
|
|
3973
|
-
|
|
3974
|
-
:type: bool
|
|
3975
|
-
"""
|
|
2909
|
+
""" A flag specifying if the torque is local."""
|
|
3976
2910
|
|
|
3977
2911
|
dLoc: typing.Any
|
|
3978
2912
|
""" The displacement vector applied by the actuator."""
|
|
3979
2913
|
|
|
3980
2914
|
useLocalDLoc: bool
|
|
3981
|
-
""" A flag specifying if the dLoc is local.
|
|
3982
|
-
|
|
3983
|
-
:type: bool
|
|
3984
|
-
"""
|
|
2915
|
+
""" A flag specifying if the dLoc is local."""
|
|
3985
2916
|
|
|
3986
2917
|
dRot: typing.Any
|
|
3987
2918
|
""" The angular displacement vector applied by the actuator"""
|
|
3988
2919
|
|
|
3989
2920
|
useLocalDRot: bool
|
|
3990
|
-
""" A flag specifying if the dRot is local.
|
|
3991
|
-
|
|
3992
|
-
:type: bool
|
|
3993
|
-
"""
|
|
2921
|
+
""" A flag specifying if the dRot is local."""
|
|
3994
2922
|
|
|
3995
2923
|
linV: typing.Any
|
|
3996
2924
|
""" The linear velocity applied by the actuator."""
|
|
3997
2925
|
|
|
3998
2926
|
useLocalLinV: bool
|
|
3999
|
-
""" A flag specifying if the linear velocity is local.
|
|
4000
|
-
|
|
4001
|
-
:type: bool
|
|
4002
|
-
"""
|
|
2927
|
+
""" A flag specifying if the linear velocity is local."""
|
|
4003
2928
|
|
|
4004
2929
|
angV: typing.Any
|
|
4005
2930
|
""" The angular velocity applied by the actuator."""
|
|
4006
2931
|
|
|
4007
2932
|
useLocalAngV: bool
|
|
4008
|
-
""" A flag specifying if the angular velocity is local.
|
|
4009
|
-
|
|
4010
|
-
:type: bool
|
|
4011
|
-
"""
|
|
2933
|
+
""" A flag specifying if the angular velocity is local."""
|
|
4012
2934
|
|
|
4013
2935
|
damping: typing.Any
|
|
4014
2936
|
""" The damping parameter of the servo controller."""
|
|
@@ -4023,10 +2945,7 @@ class SCA_ObjectActuator:
|
|
|
4023
2945
|
""" The min/max force limit along the Z axis and activates or deactivates the limits in the servo controller."""
|
|
4024
2946
|
|
|
4025
2947
|
pid: list[float]
|
|
4026
|
-
""" The PID coefficients of the servo controller.
|
|
4027
|
-
|
|
4028
|
-
:type: list[float]
|
|
4029
|
-
"""
|
|
2948
|
+
""" The PID coefficients of the servo controller."""
|
|
4030
2949
|
|
|
4031
2950
|
reference: typing.Any
|
|
4032
2951
|
""" The object that is used as reference to compute the velocity for the servo controller."""
|
|
@@ -4041,144 +2960,91 @@ class SCA_ParentActuator:
|
|
|
4041
2960
|
""" The mode of this actuator."""
|
|
4042
2961
|
|
|
4043
2962
|
compound: bool
|
|
4044
|
-
""" Whether the object shape should be added to the parent compound shape when parenting.Effective only if the parent is already a compound shape.
|
|
4045
|
-
|
|
4046
|
-
:type: bool
|
|
4047
|
-
"""
|
|
2963
|
+
""" Whether the object shape should be added to the parent compound shape when parenting.Effective only if the parent is already a compound shape."""
|
|
4048
2964
|
|
|
4049
2965
|
ghost: bool
|
|
4050
2966
|
""" Whether the object should be made ghost when parenting
|
|
4051
|
-
Effective only if the shape is not added to the parent compound shape.
|
|
4052
|
-
|
|
4053
|
-
:type: bool
|
|
4054
|
-
"""
|
|
2967
|
+
Effective only if the shape is not added to the parent compound shape."""
|
|
4055
2968
|
|
|
4056
2969
|
class SCA_PropertyActuator:
|
|
4057
2970
|
"""Property Actuator"""
|
|
4058
2971
|
|
|
4059
2972
|
propName: str
|
|
4060
|
-
""" the property on which to operate.
|
|
4061
|
-
|
|
4062
|
-
:type: str
|
|
4063
|
-
"""
|
|
2973
|
+
""" the property on which to operate."""
|
|
4064
2974
|
|
|
4065
2975
|
value: str
|
|
4066
|
-
""" the value with which the actuator operates.
|
|
4067
|
-
|
|
4068
|
-
:type: str
|
|
4069
|
-
"""
|
|
2976
|
+
""" the value with which the actuator operates."""
|
|
4070
2977
|
|
|
4071
2978
|
mode: int
|
|
4072
|
-
""" TODO - add constants to game logic dict!.
|
|
4073
|
-
|
|
4074
|
-
:type: int
|
|
4075
|
-
"""
|
|
2979
|
+
""" TODO - add constants to game logic dict!."""
|
|
4076
2980
|
|
|
4077
2981
|
class SCA_PropertySensor:
|
|
4078
2982
|
"""Activates when the game object property matches."""
|
|
4079
2983
|
|
|
4080
2984
|
mode: int
|
|
4081
|
-
""" Type of check on the property. Can be one of `these constants <logic-property-sensor>`
|
|
4082
|
-
|
|
4083
|
-
:type: int
|
|
4084
|
-
"""
|
|
2985
|
+
""" Type of check on the property. Can be one of `these constants <logic-property-sensor>`"""
|
|
4085
2986
|
|
|
4086
2987
|
propName: str
|
|
4087
|
-
""" the property the sensor operates.
|
|
4088
|
-
|
|
4089
|
-
:type: str
|
|
4090
|
-
"""
|
|
2988
|
+
""" the property the sensor operates."""
|
|
4091
2989
|
|
|
4092
2990
|
value: str
|
|
4093
|
-
""" the value with which the sensor compares to the value of the property.
|
|
4094
|
-
|
|
4095
|
-
:type: str
|
|
4096
|
-
"""
|
|
2991
|
+
""" the value with which the sensor compares to the value of the property."""
|
|
4097
2992
|
|
|
4098
2993
|
min: str
|
|
4099
|
-
""" the minimum value of the range used to evaluate the property when in interval mode.
|
|
4100
|
-
|
|
4101
|
-
:type: str
|
|
4102
|
-
"""
|
|
2994
|
+
""" the minimum value of the range used to evaluate the property when in interval mode."""
|
|
4103
2995
|
|
|
4104
2996
|
max: str
|
|
4105
|
-
""" the maximum value of the range used to evaluate the property when in interval mode.
|
|
4106
|
-
|
|
4107
|
-
:type: str
|
|
4108
|
-
"""
|
|
2997
|
+
""" the maximum value of the range used to evaluate the property when in interval mode."""
|
|
4109
2998
|
|
|
4110
2999
|
class SCA_PythonController:
|
|
4111
|
-
"""A Python controller uses a Python script to activate
|
|
4112
|
-
based on
|
|
3000
|
+
"""A Python controller uses a Python script to activate its actuators,
|
|
3001
|
+
based on its sensors.
|
|
4113
3002
|
"""
|
|
4114
3003
|
|
|
4115
3004
|
owner: typing.Any
|
|
4116
3005
|
""" The object the controller is attached to."""
|
|
4117
3006
|
|
|
4118
3007
|
script: str
|
|
4119
|
-
""" The value of this variable depends on the execution method.
|
|
4120
|
-
|
|
4121
|
-
:type: str
|
|
4122
|
-
"""
|
|
3008
|
+
""" The value of this variable depends on the execution method."""
|
|
4123
3009
|
|
|
4124
3010
|
mode: int
|
|
4125
|
-
""" the execution mode for this controller (read-only).
|
|
4126
|
-
|
|
4127
|
-
:type: int
|
|
4128
|
-
"""
|
|
3011
|
+
""" the execution mode for this controller (read-only)."""
|
|
4129
3012
|
|
|
4130
|
-
def activate(self, actuator: str):
|
|
3013
|
+
def activate(self, actuator: str) -> None:
|
|
4131
3014
|
"""Activates an actuator attached to this controller.
|
|
4132
3015
|
|
|
4133
3016
|
:param actuator: The actuator to operate on. Expects either an actuator instance or its name.
|
|
4134
|
-
:type actuator: str
|
|
4135
3017
|
"""
|
|
4136
3018
|
|
|
4137
|
-
def deactivate(self, actuator: str):
|
|
3019
|
+
def deactivate(self, actuator: str) -> None:
|
|
4138
3020
|
"""Deactivates an actuator attached to this controller.
|
|
4139
3021
|
|
|
4140
3022
|
:param actuator: The actuator to operate on. Expects either an actuator instance or its name.
|
|
4141
|
-
:type actuator: str
|
|
4142
3023
|
"""
|
|
4143
3024
|
|
|
4144
3025
|
class SCA_PythonJoystick:
|
|
4145
3026
|
"""A Python interface to a joystick."""
|
|
4146
3027
|
|
|
4147
3028
|
name: str
|
|
4148
|
-
""" The name assigned to the joystick by the operating system. (read-only)
|
|
4149
|
-
|
|
4150
|
-
:type: str
|
|
4151
|
-
"""
|
|
3029
|
+
""" The name assigned to the joystick by the operating system. (read-only)"""
|
|
4152
3030
|
|
|
4153
3031
|
activeButtons: list
|
|
4154
|
-
""" A list of active button values. (read-only)
|
|
4155
|
-
|
|
4156
|
-
:type: list
|
|
4157
|
-
"""
|
|
3032
|
+
""" A list of active button values. (read-only)"""
|
|
4158
3033
|
|
|
4159
3034
|
axisValues: list[int]
|
|
4160
3035
|
""" The state of the joysticks axis as a list of values `numAxis` long. (read-only).Each specifying the value of an axis between -1.0 and 1.0
|
|
4161
3036
|
depending on how far the axis is pushed, 0 for nothing.
|
|
4162
3037
|
The first 2 values are used by most joysticks and gamepads for directional control.
|
|
4163
|
-
3rd and 4th values are only on some joysticks and can be used for arbitrary controls.
|
|
4164
|
-
|
|
4165
|
-
:type: list[int]
|
|
4166
|
-
"""
|
|
3038
|
+
3rd and 4th values are only on some joysticks and can be used for arbitrary controls."""
|
|
4167
3039
|
|
|
4168
3040
|
hatValues: typing.Any
|
|
4169
3041
|
""" Use `activeButtons` instead.0.2.2"""
|
|
4170
3042
|
|
|
4171
3043
|
numAxis: int
|
|
4172
|
-
""" The number of axes for the joystick at this index. (read-only).
|
|
4173
|
-
|
|
4174
|
-
:type: int
|
|
4175
|
-
"""
|
|
3044
|
+
""" The number of axes for the joystick at this index. (read-only)."""
|
|
4176
3045
|
|
|
4177
3046
|
numButtons: int
|
|
4178
|
-
""" The number of buttons for the joystick at this index. (read-only).
|
|
4179
|
-
|
|
4180
|
-
:type: int
|
|
4181
|
-
"""
|
|
3047
|
+
""" The number of buttons for the joystick at this index. (read-only)."""
|
|
4182
3048
|
|
|
4183
3049
|
numHats: typing.Any
|
|
4184
3050
|
""" Use `numButtons` instead.0.2.2"""
|
|
@@ -4198,13 +3064,13 @@ The first 2 values are used by most joysticks and gamepads for directional contr
|
|
|
4198
3064
|
hasVibration: typing.Any
|
|
4199
3065
|
""" Check if the joystick supports vibration"""
|
|
4200
3066
|
|
|
4201
|
-
def startVibration(self):
|
|
3067
|
+
def startVibration(self) -> None:
|
|
4202
3068
|
"""Starts the vibration.
|
|
4203
3069
|
|
|
4204
3070
|
:return: None
|
|
4205
3071
|
"""
|
|
4206
3072
|
|
|
4207
|
-
def stopVibration(self):
|
|
3073
|
+
def stopVibration(self) -> None:
|
|
4208
3074
|
"""Stops the vibration.
|
|
4209
3075
|
|
|
4210
3076
|
:return: None
|
|
@@ -4214,111 +3080,67 @@ class SCA_PythonKeyboard:
|
|
|
4214
3080
|
"""The current keyboard."""
|
|
4215
3081
|
|
|
4216
3082
|
inputs: dict
|
|
4217
|
-
""" A dictionary containing the input of each keyboard key. (read-only).
|
|
4218
|
-
|
|
4219
|
-
:type: dict
|
|
4220
|
-
"""
|
|
3083
|
+
""" A dictionary containing the input of each keyboard key. (read-only)."""
|
|
4221
3084
|
|
|
4222
3085
|
events: dict
|
|
4223
|
-
""" A dictionary containing the status of each keyboard event or key. (read-only).Use `inputs`.0.2.2
|
|
4224
|
-
|
|
4225
|
-
:type: dict
|
|
4226
|
-
"""
|
|
3086
|
+
""" A dictionary containing the status of each keyboard event or key. (read-only).Use `inputs`.0.2.2"""
|
|
4227
3087
|
|
|
4228
3088
|
activeInputs: dict
|
|
4229
|
-
""" A dictionary containing the input of only the active keyboard keys. (read-only).
|
|
4230
|
-
|
|
4231
|
-
:type: dict
|
|
4232
|
-
"""
|
|
3089
|
+
""" A dictionary containing the input of only the active keyboard keys. (read-only)."""
|
|
4233
3090
|
|
|
4234
3091
|
active_events: dict
|
|
4235
|
-
""" A dictionary containing the status of only the active keyboard events or keys. (read-only).Use `activeInputs`.0.2.2
|
|
4236
|
-
|
|
4237
|
-
:type: dict
|
|
4238
|
-
"""
|
|
3092
|
+
""" A dictionary containing the status of only the active keyboard events or keys. (read-only).Use `activeInputs`.0.2.2"""
|
|
4239
3093
|
|
|
4240
3094
|
text: str
|
|
4241
|
-
""" The typed unicode text from the last frame.
|
|
4242
|
-
|
|
4243
|
-
:type: str
|
|
4244
|
-
"""
|
|
3095
|
+
""" The typed unicode text from the last frame."""
|
|
4245
3096
|
|
|
4246
3097
|
def getClipboard(self) -> str:
|
|
4247
3098
|
"""Gets the clipboard text.
|
|
4248
3099
|
|
|
4249
3100
|
:return:
|
|
4250
|
-
:rtype: str
|
|
4251
3101
|
"""
|
|
4252
3102
|
|
|
4253
|
-
def setClipboard(self, text: str):
|
|
3103
|
+
def setClipboard(self, text: str) -> None:
|
|
4254
3104
|
"""Sets the clipboard text.
|
|
4255
3105
|
|
|
4256
3106
|
:param text: New clipboard text
|
|
4257
|
-
:type text: str
|
|
4258
3107
|
"""
|
|
4259
3108
|
|
|
4260
3109
|
class SCA_PythonMouse:
|
|
4261
3110
|
"""The current mouse."""
|
|
4262
3111
|
|
|
4263
3112
|
inputs: dict
|
|
4264
|
-
""" A dictionary containing the input of each mouse event. (read-only).
|
|
4265
|
-
|
|
4266
|
-
:type: dict
|
|
4267
|
-
"""
|
|
3113
|
+
""" A dictionary containing the input of each mouse event. (read-only)."""
|
|
4268
3114
|
|
|
4269
3115
|
events: dict
|
|
4270
|
-
""" a dictionary containing the status of each mouse event. (read-only).Use `inputs`.0.2.2
|
|
4271
|
-
|
|
4272
|
-
:type: dict
|
|
4273
|
-
"""
|
|
3116
|
+
""" a dictionary containing the status of each mouse event. (read-only).Use `inputs`.0.2.2"""
|
|
4274
3117
|
|
|
4275
3118
|
activeInputs: dict
|
|
4276
|
-
""" A dictionary containing the input of only the active mouse events. (read-only).
|
|
4277
|
-
|
|
4278
|
-
:type: dict
|
|
4279
|
-
"""
|
|
3119
|
+
""" A dictionary containing the input of only the active mouse events. (read-only)."""
|
|
4280
3120
|
|
|
4281
3121
|
active_events: dict
|
|
4282
|
-
""" a dictionary containing the status of only the active mouse events. (read-only).Use `activeInputs`.0.2.2
|
|
4283
|
-
|
|
4284
|
-
:type: dict
|
|
4285
|
-
"""
|
|
3122
|
+
""" a dictionary containing the status of only the active mouse events. (read-only).Use `activeInputs`.0.2.2"""
|
|
4286
3123
|
|
|
4287
3124
|
position: typing.Any
|
|
4288
3125
|
""" The normalized x and y position of the mouse cursor."""
|
|
4289
3126
|
|
|
4290
3127
|
visible: bool
|
|
4291
|
-
""" The visibility of the mouse cursor.
|
|
4292
|
-
|
|
4293
|
-
:type: bool
|
|
4294
|
-
"""
|
|
3128
|
+
""" The visibility of the mouse cursor."""
|
|
4295
3129
|
|
|
4296
3130
|
class SCA_RadarSensor:
|
|
4297
3131
|
"""Radar sensor is a near sensor with a conical sensor object."""
|
|
4298
3132
|
|
|
4299
3133
|
coneOrigin: list[float]
|
|
4300
|
-
""" The origin of the cone with which to test. The origin is in the middle of the cone. (read-only).
|
|
4301
|
-
|
|
4302
|
-
:type: list[float]
|
|
4303
|
-
"""
|
|
3134
|
+
""" The origin of the cone with which to test. The origin is in the middle of the cone. (read-only)."""
|
|
4304
3135
|
|
|
4305
3136
|
coneTarget: list[float]
|
|
4306
|
-
""" The center of the bottom face of the cone with which to test. (read-only).
|
|
4307
|
-
|
|
4308
|
-
:type: list[float]
|
|
4309
|
-
"""
|
|
3137
|
+
""" The center of the bottom face of the cone with which to test. (read-only)."""
|
|
4310
3138
|
|
|
4311
3139
|
distance: float
|
|
4312
|
-
""" The height of the cone with which to test (read-only).
|
|
4313
|
-
|
|
4314
|
-
:type: float
|
|
4315
|
-
"""
|
|
3140
|
+
""" The height of the cone with which to test (read-only)."""
|
|
4316
3141
|
|
|
4317
3142
|
angle: float
|
|
4318
|
-
""" The angle of the cone (in degrees) with which to test (read-only).
|
|
4319
|
-
|
|
4320
|
-
:type: float
|
|
4321
|
-
"""
|
|
3143
|
+
""" The angle of the cone (in degrees) with which to test (read-only)."""
|
|
4322
3144
|
|
|
4323
3145
|
axis: typing.Any
|
|
4324
3146
|
""" The axis on which the radar cone is cast.KX_RADAR_AXIS_POS_X, KX_RADAR_AXIS_POS_Y, KX_RADAR_AXIS_POS_Z,
|
|
@@ -4328,46 +3150,30 @@ class SCA_RandomActuator:
|
|
|
4328
3150
|
"""Random Actuator"""
|
|
4329
3151
|
|
|
4330
3152
|
seed: int
|
|
4331
|
-
""" Seed of the random number generator.Equal seeds produce equal series. If the seed is 0, the generator will produce the same value on every call.
|
|
4332
|
-
|
|
4333
|
-
:type: int
|
|
4334
|
-
"""
|
|
3153
|
+
""" Seed of the random number generator.Equal seeds produce equal series. If the seed is 0, the generator will produce the same value on every call."""
|
|
4335
3154
|
|
|
4336
3155
|
para1: float
|
|
4337
|
-
""" the first parameter of the active distribution.Refer to the documentation of the generator types for the meaning of this value.
|
|
4338
|
-
|
|
4339
|
-
:type: float
|
|
4340
|
-
"""
|
|
3156
|
+
""" the first parameter of the active distribution.Refer to the documentation of the generator types for the meaning of this value."""
|
|
4341
3157
|
|
|
4342
3158
|
para2: float
|
|
4343
|
-
""" the second parameter of the active distribution.Refer to the documentation of the generator types for the meaning of this value.
|
|
4344
|
-
|
|
4345
|
-
:type: float
|
|
4346
|
-
"""
|
|
3159
|
+
""" the second parameter of the active distribution.Refer to the documentation of the generator types for the meaning of this value."""
|
|
4347
3160
|
|
|
4348
3161
|
distribution: int
|
|
4349
|
-
""" Distribution type. (read-only). Can be one of `these constants <logic-random-distributions>`
|
|
4350
|
-
|
|
4351
|
-
:type: int
|
|
4352
|
-
"""
|
|
3162
|
+
""" Distribution type. (read-only). Can be one of `these constants <logic-random-distributions>`"""
|
|
4353
3163
|
|
|
4354
3164
|
propName: str
|
|
4355
|
-
""" the name of the property to set with the random value.If the generator and property types do not match, the assignment is ignored.
|
|
4356
|
-
|
|
4357
|
-
:type: str
|
|
4358
|
-
"""
|
|
3165
|
+
""" the name of the property to set with the random value.If the generator and property types do not match, the assignment is ignored."""
|
|
4359
3166
|
|
|
4360
|
-
def setBoolConst(self, value: bool):
|
|
3167
|
+
def setBoolConst(self, value: bool) -> None:
|
|
4361
3168
|
"""Sets this generator to produce a constant boolean value.
|
|
4362
3169
|
|
|
4363
3170
|
:param value: The value to return.
|
|
4364
|
-
:type value: bool
|
|
4365
3171
|
"""
|
|
4366
3172
|
|
|
4367
|
-
def setBoolUniform(self):
|
|
3173
|
+
def setBoolUniform(self) -> None:
|
|
4368
3174
|
"""Sets this generator to produce a uniform boolean distribution.The generator will generate True or False with 50% chance."""
|
|
4369
3175
|
|
|
4370
|
-
def setBoolBernouilli(self, value: float):
|
|
3176
|
+
def setBoolBernouilli(self, value: float) -> None:
|
|
4371
3177
|
"""Sets this generator to produce a Bernouilli distribution.
|
|
4372
3178
|
|
|
4373
3179
|
:param value: Specifies the proportion of False values to produce.
|
|
@@ -4375,108 +3181,79 @@ class SCA_RandomActuator:
|
|
|
4375
3181
|
0.0: Always generate True
|
|
4376
3182
|
|
|
4377
3183
|
1.0: Always generate False
|
|
4378
|
-
:type value: float
|
|
4379
3184
|
"""
|
|
4380
3185
|
|
|
4381
|
-
def setIntConst(self, value: int):
|
|
3186
|
+
def setIntConst(self, value: int) -> None:
|
|
4382
3187
|
"""Sets this generator to always produce the given value.
|
|
4383
3188
|
|
|
4384
3189
|
:param value: the value this generator produces.
|
|
4385
|
-
:type value: int
|
|
4386
3190
|
"""
|
|
4387
3191
|
|
|
4388
|
-
def setIntUniform(self, lower_bound: int, upper_bound: int):
|
|
3192
|
+
def setIntUniform(self, lower_bound: int, upper_bound: int) -> None:
|
|
4389
3193
|
"""Sets this generator to produce a random value between the given lower and
|
|
4390
3194
|
upper bounds (inclusive).
|
|
4391
3195
|
|
|
4392
3196
|
:param lower_bound:
|
|
4393
|
-
:type lower_bound: int
|
|
4394
3197
|
:param upper_bound:
|
|
4395
|
-
:type upper_bound: int
|
|
4396
3198
|
"""
|
|
4397
3199
|
|
|
4398
|
-
def setIntPoisson(self, value: float):
|
|
3200
|
+
def setIntPoisson(self, value: float) -> None:
|
|
4399
3201
|
"""Generate a Poisson-distributed number.This performs a series of Bernouilli tests with parameter value.
|
|
4400
3202
|
It returns the number of tries needed to achieve success.
|
|
4401
3203
|
|
|
4402
3204
|
:param value:
|
|
4403
|
-
:type value: float
|
|
4404
3205
|
"""
|
|
4405
3206
|
|
|
4406
|
-
def setFloatConst(self, value: float):
|
|
3207
|
+
def setFloatConst(self, value: float) -> None:
|
|
4407
3208
|
"""Always generate the given value.
|
|
4408
3209
|
|
|
4409
3210
|
:param value:
|
|
4410
|
-
:type value: float
|
|
4411
3211
|
"""
|
|
4412
3212
|
|
|
4413
|
-
def setFloatUniform(self, lower_bound: float, upper_bound: float):
|
|
3213
|
+
def setFloatUniform(self, lower_bound: float, upper_bound: float) -> None:
|
|
4414
3214
|
"""Generates a random float between lower_bound and upper_bound with a
|
|
4415
3215
|
uniform distribution.
|
|
4416
3216
|
|
|
4417
3217
|
:param lower_bound:
|
|
4418
|
-
:type lower_bound: float
|
|
4419
3218
|
:param upper_bound:
|
|
4420
|
-
:type upper_bound: float
|
|
4421
3219
|
"""
|
|
4422
3220
|
|
|
4423
|
-
def setFloatNormal(self, mean: float, standard_deviation: float):
|
|
3221
|
+
def setFloatNormal(self, mean: float, standard_deviation: float) -> None:
|
|
4424
3222
|
"""Generates a random float from the given normal distribution.
|
|
4425
3223
|
|
|
4426
3224
|
:param mean: The mean (average) value of the generated numbers
|
|
4427
|
-
:type mean: float
|
|
4428
3225
|
:param standard_deviation: The standard deviation of the generated numbers.
|
|
4429
|
-
:type standard_deviation: float
|
|
4430
3226
|
"""
|
|
4431
3227
|
|
|
4432
|
-
def setFloatNegativeExponential(self, half_life: float):
|
|
4433
|
-
"""Generate negative-exponentially distributed numbers.The half-life
|
|
3228
|
+
def setFloatNegativeExponential(self, half_life: float) -> None:
|
|
3229
|
+
"""Generate negative-exponentially distributed numbers.The half-life time is characterized by half_life.
|
|
4434
3230
|
|
|
4435
3231
|
:param half_life:
|
|
4436
|
-
:type half_life: float
|
|
4437
3232
|
"""
|
|
4438
3233
|
|
|
4439
3234
|
class SCA_RandomSensor:
|
|
4440
3235
|
"""This sensor activates randomly."""
|
|
4441
3236
|
|
|
4442
3237
|
lastDraw: int
|
|
4443
|
-
""" The seed of the random number generator.
|
|
4444
|
-
|
|
4445
|
-
:type: int
|
|
4446
|
-
"""
|
|
3238
|
+
""" The seed of the random number generator."""
|
|
4447
3239
|
|
|
4448
3240
|
seed: int
|
|
4449
|
-
""" The seed of the random number generator.
|
|
4450
|
-
|
|
4451
|
-
:type: int
|
|
4452
|
-
"""
|
|
3241
|
+
""" The seed of the random number generator."""
|
|
4453
3242
|
|
|
4454
3243
|
class SCA_RaySensor:
|
|
4455
3244
|
"""A ray sensor detects the first object in a given direction."""
|
|
4456
3245
|
|
|
4457
3246
|
propName: str
|
|
4458
|
-
""" The property the ray is looking for.
|
|
4459
|
-
|
|
4460
|
-
:type: str
|
|
4461
|
-
"""
|
|
3247
|
+
""" The property the ray is looking for."""
|
|
4462
3248
|
|
|
4463
3249
|
range: float
|
|
4464
|
-
""" The distance of the ray.
|
|
4465
|
-
|
|
4466
|
-
:type: float
|
|
4467
|
-
"""
|
|
3250
|
+
""" The distance of the ray."""
|
|
4468
3251
|
|
|
4469
3252
|
useMaterial: bool
|
|
4470
|
-
""" Whether or not to look for a material (false = property).
|
|
4471
|
-
|
|
4472
|
-
:type: bool
|
|
4473
|
-
"""
|
|
3253
|
+
""" Whether or not to look for a material (false = property)."""
|
|
4474
3254
|
|
|
4475
3255
|
useXRay: bool
|
|
4476
|
-
""" Whether or not to use XRay.
|
|
4477
|
-
|
|
4478
|
-
:type: bool
|
|
4479
|
-
"""
|
|
3256
|
+
""" Whether or not to use XRay."""
|
|
4480
3257
|
|
|
4481
3258
|
mask: typing.Any
|
|
4482
3259
|
""" The collision mask (16 layers mapped to a 16-bit integer) combined with each object's collision group, to hit only a subset of the
|
|
@@ -4492,10 +3269,7 @@ objects in the scene. Only those objects for which collisionGroup & mask is true
|
|
|
4492
3269
|
""" The normal (in worldcoordinates) of the object at the location where the object was hit by the ray. (read-only)."""
|
|
4493
3270
|
|
|
4494
3271
|
hitMaterial: str
|
|
4495
|
-
""" The material of the object in the face hit by the ray. (read-only).
|
|
4496
|
-
|
|
4497
|
-
:type: str
|
|
4498
|
-
"""
|
|
3272
|
+
""" The material of the object in the face hit by the ray. (read-only)."""
|
|
4499
3273
|
|
|
4500
3274
|
rayDirection: typing.Any
|
|
4501
3275
|
""" The direction from the ray (in worldcoordinates). (read-only)."""
|
|
@@ -4510,40 +3284,25 @@ class SCA_ReplaceMeshActuator:
|
|
|
4510
3284
|
""" `~bge.types.KX_MeshProxy` or the name of the mesh that will replace the current one.Set to None to disable actuator."""
|
|
4511
3285
|
|
|
4512
3286
|
useDisplayMesh: bool
|
|
4513
|
-
""" when true the displayed mesh is replaced.
|
|
4514
|
-
|
|
4515
|
-
:type: bool
|
|
4516
|
-
"""
|
|
3287
|
+
""" when true the displayed mesh is replaced."""
|
|
4517
3288
|
|
|
4518
3289
|
usePhysicsMesh: bool
|
|
4519
|
-
""" when true the physics mesh is replaced.
|
|
4520
|
-
|
|
4521
|
-
:type: bool
|
|
4522
|
-
"""
|
|
3290
|
+
""" when true the physics mesh is replaced."""
|
|
4523
3291
|
|
|
4524
|
-
def instantReplaceMesh(self):
|
|
3292
|
+
def instantReplaceMesh(self) -> None:
|
|
4525
3293
|
"""Immediately replace mesh without delay."""
|
|
4526
3294
|
|
|
4527
3295
|
class SCA_SceneActuator:
|
|
4528
3296
|
"""Scene Actuator logic brick."""
|
|
4529
3297
|
|
|
4530
3298
|
scene: str
|
|
4531
|
-
""" the name of the scene to change to/overlay/underlay/remove/suspend/resume.
|
|
4532
|
-
|
|
4533
|
-
:type: str
|
|
4534
|
-
"""
|
|
3299
|
+
""" the name of the scene to change to/overlay/underlay/remove/suspend/resume."""
|
|
4535
3300
|
|
|
4536
3301
|
camera: str
|
|
4537
|
-
""" the camera to change to.
|
|
4538
|
-
|
|
4539
|
-
:type: str
|
|
4540
|
-
"""
|
|
3302
|
+
""" the camera to change to."""
|
|
4541
3303
|
|
|
4542
3304
|
useRestart: bool
|
|
4543
|
-
""" Set flag to True to restart the sene.
|
|
4544
|
-
|
|
4545
|
-
:type: bool
|
|
4546
|
-
"""
|
|
3305
|
+
""" Set flag to True to restart the sene."""
|
|
4547
3306
|
|
|
4548
3307
|
mode: typing.Any
|
|
4549
3308
|
""" The mode of the actuator."""
|
|
@@ -4552,102 +3311,63 @@ class SCA_SoundActuator:
|
|
|
4552
3311
|
"""Sound Actuator.The `startSound`, `pauseSound` and `stopSound` do not require the actuator to be activated - they act instantly provided that the actuator has been activated once at least."""
|
|
4553
3312
|
|
|
4554
3313
|
volume: float
|
|
4555
|
-
""" The volume (gain) of the sound.
|
|
4556
|
-
|
|
4557
|
-
:type: float
|
|
4558
|
-
"""
|
|
3314
|
+
""" The volume (gain) of the sound."""
|
|
4559
3315
|
|
|
4560
3316
|
time: float
|
|
4561
|
-
""" The current position in the audio stream (in seconds).
|
|
4562
|
-
|
|
4563
|
-
:type: float
|
|
4564
|
-
"""
|
|
3317
|
+
""" The current position in the audio stream (in seconds)."""
|
|
4565
3318
|
|
|
4566
3319
|
pitch: float
|
|
4567
|
-
""" The pitch of the sound.
|
|
4568
|
-
|
|
4569
|
-
:type: float
|
|
4570
|
-
"""
|
|
3320
|
+
""" The pitch of the sound."""
|
|
4571
3321
|
|
|
4572
3322
|
mode: int
|
|
4573
|
-
""" The operation mode of the actuator. Can be one of `these constants<logic-sound-actuator>`
|
|
4574
|
-
|
|
4575
|
-
:type: int
|
|
4576
|
-
"""
|
|
3323
|
+
""" The operation mode of the actuator. Can be one of `these constants<logic-sound-actuator>`"""
|
|
4577
3324
|
|
|
4578
3325
|
sound: aud.Sound
|
|
4579
|
-
""" The sound the actuator should play.
|
|
4580
|
-
|
|
4581
|
-
:type: aud.Sound
|
|
4582
|
-
"""
|
|
3326
|
+
""" The sound the actuator should play."""
|
|
4583
3327
|
|
|
4584
3328
|
is3D: bool
|
|
4585
|
-
""" Whether or not the actuator should be using 3D sound. (read-only)
|
|
3329
|
+
""" Whether or not the actuator should be using 3D sound. (read-only)"""
|
|
4586
3330
|
|
|
4587
|
-
:
|
|
4588
|
-
"""
|
|
3331
|
+
preload: bool
|
|
3332
|
+
""" Control whether to keep a RAM-buffered copy for fast re-triggers"""
|
|
4589
3333
|
|
|
4590
3334
|
volume_maximum: float
|
|
4591
|
-
""" The maximum gain of the sound, no matter how near it is.
|
|
4592
|
-
|
|
4593
|
-
:type: float
|
|
4594
|
-
"""
|
|
3335
|
+
""" The maximum gain of the sound, no matter how near it is."""
|
|
4595
3336
|
|
|
4596
3337
|
volume_minimum: float
|
|
4597
|
-
""" The minimum gain of the sound, no matter how far it is away.
|
|
4598
|
-
|
|
4599
|
-
:type: float
|
|
4600
|
-
"""
|
|
3338
|
+
""" The minimum gain of the sound, no matter how far it is away."""
|
|
4601
3339
|
|
|
4602
3340
|
distance_reference: float
|
|
4603
|
-
""" The distance where the sound has a gain of 1.0.
|
|
4604
|
-
|
|
4605
|
-
:type: float
|
|
4606
|
-
"""
|
|
3341
|
+
""" The distance where the sound has a gain of 1.0."""
|
|
4607
3342
|
|
|
4608
3343
|
distance_maximum: float
|
|
4609
|
-
""" The maximum distance at which you can hear the sound.
|
|
4610
|
-
|
|
4611
|
-
:type: float
|
|
4612
|
-
"""
|
|
3344
|
+
""" The maximum distance at which you can hear the sound."""
|
|
4613
3345
|
|
|
4614
3346
|
attenuation: float
|
|
4615
|
-
""" The influence factor on volume depending on distance.
|
|
4616
|
-
|
|
4617
|
-
:type: float
|
|
4618
|
-
"""
|
|
3347
|
+
""" The influence factor on volume depending on distance."""
|
|
4619
3348
|
|
|
4620
3349
|
cone_angle_inner: float
|
|
4621
|
-
""" The angle of the inner cone.
|
|
4622
|
-
|
|
4623
|
-
:type: float
|
|
4624
|
-
"""
|
|
3350
|
+
""" The angle of the inner cone."""
|
|
4625
3351
|
|
|
4626
3352
|
cone_angle_outer: float
|
|
4627
|
-
""" The angle of the outer cone.
|
|
4628
|
-
|
|
4629
|
-
:type: float
|
|
4630
|
-
"""
|
|
3353
|
+
""" The angle of the outer cone."""
|
|
4631
3354
|
|
|
4632
3355
|
cone_volume_outer: float
|
|
4633
|
-
""" The gain outside the outer cone (the gain in the outer cone will be interpolated between this value and the normal gain in the inner cone).
|
|
3356
|
+
""" The gain outside the outer cone (the gain in the outer cone will be interpolated between this value and the normal gain in the inner cone)."""
|
|
4634
3357
|
|
|
4635
|
-
:
|
|
4636
|
-
"""
|
|
4637
|
-
|
|
4638
|
-
def startSound(self):
|
|
3358
|
+
def startSound(self) -> None:
|
|
4639
3359
|
"""Starts the sound.
|
|
4640
3360
|
|
|
4641
3361
|
:return: None
|
|
4642
3362
|
"""
|
|
4643
3363
|
|
|
4644
|
-
def pauseSound(self):
|
|
3364
|
+
def pauseSound(self) -> None:
|
|
4645
3365
|
"""Pauses the sound.
|
|
4646
3366
|
|
|
4647
3367
|
:return: None
|
|
4648
3368
|
"""
|
|
4649
3369
|
|
|
4650
|
-
def stopSound(self):
|
|
3370
|
+
def stopSound(self) -> None:
|
|
4651
3371
|
"""Stops the sound.
|
|
4652
3372
|
|
|
4653
3373
|
:return: None
|
|
@@ -4657,49 +3377,28 @@ class SCA_StateActuator:
|
|
|
4657
3377
|
"""State actuator changes the state mask of parent object."""
|
|
4658
3378
|
|
|
4659
3379
|
operation: int
|
|
4660
|
-
""" Type of bit operation to be applied on object state mask.You can use one of `these constants <state-actuator-operation>`
|
|
4661
|
-
|
|
4662
|
-
:type: int
|
|
4663
|
-
"""
|
|
3380
|
+
""" Type of bit operation to be applied on object state mask.You can use one of `these constants <state-actuator-operation>`"""
|
|
4664
3381
|
|
|
4665
3382
|
mask: int
|
|
4666
|
-
""" Value that defines the bits that will be modified by the operation.The bits that are 1 in the mask will be updated in the object state.The bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state.
|
|
4667
|
-
|
|
4668
|
-
:type: int
|
|
4669
|
-
"""
|
|
3383
|
+
""" Value that defines the bits that will be modified by the operation.The bits that are 1 in the mask will be updated in the object state.The bits that are 0 are will be left unmodified expect for the Copy operation which copies the mask to the object state."""
|
|
4670
3384
|
|
|
4671
3385
|
class SCA_SteeringActuator:
|
|
4672
3386
|
"""Steering Actuator for navigation."""
|
|
4673
3387
|
|
|
4674
3388
|
behavior: int
|
|
4675
|
-
""" The steering behavior to use. One of `these constants <logic-steering-actuator>`.
|
|
4676
|
-
|
|
4677
|
-
:type: int
|
|
4678
|
-
"""
|
|
3389
|
+
""" The steering behavior to use. One of `these constants <logic-steering-actuator>`."""
|
|
4679
3390
|
|
|
4680
3391
|
velocity: float
|
|
4681
|
-
""" Velocity magnitude
|
|
4682
|
-
|
|
4683
|
-
:type: float
|
|
4684
|
-
"""
|
|
3392
|
+
""" Velocity magnitude"""
|
|
4685
3393
|
|
|
4686
3394
|
acceleration: float
|
|
4687
|
-
""" Max acceleration
|
|
4688
|
-
|
|
4689
|
-
:type: float
|
|
4690
|
-
"""
|
|
3395
|
+
""" Max acceleration"""
|
|
4691
3396
|
|
|
4692
3397
|
turnspeed: float
|
|
4693
|
-
""" Max turn speed
|
|
4694
|
-
|
|
4695
|
-
:type: float
|
|
4696
|
-
"""
|
|
3398
|
+
""" Max turn speed"""
|
|
4697
3399
|
|
|
4698
3400
|
distance: float
|
|
4699
|
-
""" Relax distance
|
|
4700
|
-
|
|
4701
|
-
:type: float
|
|
4702
|
-
"""
|
|
3401
|
+
""" Relax distance"""
|
|
4703
3402
|
|
|
4704
3403
|
target: typing.Any
|
|
4705
3404
|
""" Target object"""
|
|
@@ -4708,28 +3407,22 @@ class SCA_SteeringActuator:
|
|
|
4708
3407
|
""" Navigation mesh"""
|
|
4709
3408
|
|
|
4710
3409
|
selfterminated: bool
|
|
4711
|
-
""" Terminate when target is reached
|
|
4712
|
-
|
|
4713
|
-
:type: bool
|
|
4714
|
-
"""
|
|
3410
|
+
""" Terminate when target is reached"""
|
|
4715
3411
|
|
|
4716
3412
|
enableVisualization: bool
|
|
4717
|
-
""" Enable debug visualization
|
|
3413
|
+
""" Enable debug visualization"""
|
|
4718
3414
|
|
|
4719
|
-
:
|
|
4720
|
-
"""
|
|
3415
|
+
lockZVelocity: bool
|
|
3416
|
+
""" Disable simulation of linear motion along z axis"""
|
|
4721
3417
|
|
|
4722
3418
|
pathUpdatePeriod: int
|
|
4723
|
-
""" Path update period
|
|
3419
|
+
""" Path update period"""
|
|
4724
3420
|
|
|
4725
|
-
:
|
|
4726
|
-
"""
|
|
3421
|
+
pathLerpFactor: float
|
|
3422
|
+
""" Interpolation to smooth steering when changing paths or between different directions of the same path"""
|
|
4727
3423
|
|
|
4728
3424
|
path: list[mathutils.Vector]
|
|
4729
|
-
""" Path point list.
|
|
4730
|
-
|
|
4731
|
-
:type: list[mathutils.Vector]
|
|
4732
|
-
"""
|
|
3425
|
+
""" Path point list."""
|
|
4733
3426
|
|
|
4734
3427
|
class SCA_TrackToActuator:
|
|
4735
3428
|
"""Edit Object actuator in Track To mode."""
|
|
@@ -4738,16 +3431,10 @@ class SCA_TrackToActuator:
|
|
|
4738
3431
|
""" the object this actuator tracks."""
|
|
4739
3432
|
|
|
4740
3433
|
time: int
|
|
4741
|
-
""" the time in frames with which to delay the tracking motion.
|
|
4742
|
-
|
|
4743
|
-
:type: int
|
|
4744
|
-
"""
|
|
3434
|
+
""" the time in frames with which to delay the tracking motion."""
|
|
4745
3435
|
|
|
4746
3436
|
use3D: bool
|
|
4747
|
-
""" the tracking motion to use 3D.
|
|
4748
|
-
|
|
4749
|
-
:type: bool
|
|
4750
|
-
"""
|
|
3437
|
+
""" the tracking motion to use 3D."""
|
|
4751
3438
|
|
|
4752
3439
|
upAxis: typing.Any
|
|
4753
3440
|
""" The axis that points upward."""
|
|
@@ -4776,13 +3463,13 @@ class SCA_VibrationActuator:
|
|
|
4776
3463
|
hasVibration: typing.Any
|
|
4777
3464
|
""" Check if the joystick supports vibration"""
|
|
4778
3465
|
|
|
4779
|
-
def startVibration(self):
|
|
3466
|
+
def startVibration(self) -> None:
|
|
4780
3467
|
"""Starts the vibration.
|
|
4781
3468
|
|
|
4782
3469
|
:return: None
|
|
4783
3470
|
"""
|
|
4784
3471
|
|
|
4785
|
-
def stopVibration(self):
|
|
3472
|
+
def stopVibration(self) -> None:
|
|
4786
3473
|
"""Stops the vibration.
|
|
4787
3474
|
|
|
4788
3475
|
:return: None
|
|
@@ -4792,22 +3479,13 @@ class SCA_VisibilityActuator:
|
|
|
4792
3479
|
"""Visibility Actuator."""
|
|
4793
3480
|
|
|
4794
3481
|
visibility: bool
|
|
4795
|
-
""" whether the actuator makes its parent object visible or invisible.
|
|
4796
|
-
|
|
4797
|
-
:type: bool
|
|
4798
|
-
"""
|
|
3482
|
+
""" whether the actuator makes its parent object visible or invisible."""
|
|
4799
3483
|
|
|
4800
3484
|
useOcclusion: bool
|
|
4801
|
-
""" whether the actuator makes its parent object an occluder or not.
|
|
4802
|
-
|
|
4803
|
-
:type: bool
|
|
4804
|
-
"""
|
|
3485
|
+
""" whether the actuator makes its parent object an occluder or not."""
|
|
4805
3486
|
|
|
4806
3487
|
useRecursion: bool
|
|
4807
|
-
""" whether the visibility/occlusion should be propagated to all children of the object.
|
|
4808
|
-
|
|
4809
|
-
:type: bool
|
|
4810
|
-
"""
|
|
3488
|
+
""" whether the visibility/occlusion should be propagated to all children of the object."""
|
|
4811
3489
|
|
|
4812
3490
|
class SCA_XNORController:
|
|
4813
3491
|
"""An XNOR controller activates when all linked sensors are the same (activated or inative).There are no special python methods for this controller."""
|
|
@@ -4819,7 +3497,34 @@ class BL_Texture(EXP_Value):
|
|
|
4819
3497
|
"""This is kept for backward compatibility with some scripts (bindCode mainly)."""
|
|
4820
3498
|
|
|
4821
3499
|
bindCode: int
|
|
4822
|
-
""" Texture bind code/Id/number.
|
|
3500
|
+
""" Texture bind code/Id/number."""
|
|
4823
3501
|
|
|
4824
|
-
|
|
3502
|
+
def addOffScreen(
|
|
3503
|
+
width: int | None = None, height: int | None = None, mipmap: bool = False
|
|
3504
|
+
) -> None:
|
|
3505
|
+
"""Register a custom off screen (framebuffer in 0.3+) to render the filter to.
|
|
3506
|
+
|
|
3507
|
+
:param width: In 0.3+, always canvas width (optional).
|
|
3508
|
+
:param height: In 0.3+, always canvas height (optional).
|
|
3509
|
+
:param mipmap: True if the color texture generate mipmap at the end of the filter rendering (optional).
|
|
4825
3510
|
"""
|
|
3511
|
+
|
|
3512
|
+
def removeOffScreen() -> None:
|
|
3513
|
+
"""Unregister the custom off screen (framebuffer in 0.3+) the filter render to."""
|
|
3514
|
+
|
|
3515
|
+
def setTexture(textureName: str = "", gputexture=None) -> None:
|
|
3516
|
+
"""Set specified GPUTexture as uniform for the 2D filter.
|
|
3517
|
+
|
|
3518
|
+
:param textureName: The name of the texture in the 2D filter code. For example if you declare:
|
|
3519
|
+
uniform sampler2D myTexture;
|
|
3520
|
+
you will have to call filter.setTexture("myTexture", gputex).
|
|
3521
|
+
:param gputexture: The gputexture (see gpu module documentation).
|
|
3522
|
+
"""
|
|
3523
|
+
|
|
3524
|
+
mipmap: bool
|
|
3525
|
+
""" Request mipmap generation of the render bgl_RenderedTexture texture.
|
|
3526
|
+
"""
|
|
3527
|
+
|
|
3528
|
+
offScreen: typing.Any
|
|
3529
|
+
""" The custom off screen (framebuffer in 0.3+) the filter render to (read-only).
|
|
3530
|
+
"""
|