BGE: Logic Brick clean up
AbandonedPublic
Actions

Authored by Jorge Bernal (lordloki) on Jun 30 2014, 2:30 AM.

Details

Reviewers

Dalai Felinto (dfelinto)
Mitchell Stokes (moguri)

Summary

This proposal http://wiki.blender.org/index.php/User:Lordloki/Logic_Bricks_cleanup_proposal borns from http://wiki.blender.org/index.php/User:Moguri/BGE_Issues to have the logic bricks properly encapsulated and organized and to allow (at last) that the logic system won't be dependent on logic brick code.

At this moment I have completed Step 1 of the proposal which includes the following:
Step 1. All Logic bricks should be put into their own folder (GameLogic)

1.1 Move the following sensors and actuators from Ketsji to Gamelogic folder: (Done)

Armature Sensor (Done)
Near Sensor (Done)
NetworkMessage Sensor (Done)
Radar Sensor (Done)
Ray Sensor (Done)
Touch Sensor (Done)
MouseFocus Sensor (Done)
Camera Actuator (Done)
Constraint Actuator (Done)
EditObject Actuators (AddObject, EndObject, ReplaceMesh, Dynamic and TrackTo) (Done)
Game Actuator (Done)
Ipo Actuator (Done)
Mouse Actuator (Done)
NetworkMessage Actuator (Done)
Object Actuator (Done)
Parent Actuator (Done)
Scene Actuator (Done)
Sound Actuator (Done)
State Actuator (Done)
Steering Actuator (Done)
Visibility Actuator (Done)

1.2 Move the following actuators from Converter to Gamelogic folder: (Done)

Action Actuator (Done)
Armature Actuator (Done)
ShapeAction Actuator (Done)

1.3 Rename filenames from KX_ and KX_SCA_ to SCA_ (Done)
1.4 Rename classes names from KX_ to SCA_ (Done)
1.5 Make everything compile. At this point, several new dependencies should be added to GameLogic CMakeList.txt (i.e. Audaspace, Physics, Ketsji, blenkernel, etc) (Done)
1.6 To update the documentation associated (rst) (Done)
1.7 Due to the ammount of code modified, to upload the diff to https://developer.blender.org/differential to check possible errors. (Done)

When this part is Ok for everybody I will proceed with the Step 2.

Diff Detail

Repository: rB Blender
Branch: bge-clean-logicbricks

Event Timeline

Some of the docs still need their titles renamed. For example, SCA_ArmatureActuator.rst's title still says BL_ArmatureActuator. These renames could potentially break scripts (in the rare case that someone was actually checking types), so we'll need to make a note in the wiki. This would probably also be a good time to rename the "ObjectActuator" to it's more well-known name of "MotionActuator," but this can be done as a separate commit to keep things organized. You should also avoid too many style changes in this patch (e.g., SCA_VisibilityActuator.h).

There is still a dependency that I know of in KX_GameObject, which is leveraged by a number of places (ConvertPythonToGameObject)
Line 3673 "(KX_GameObject*)SCA_ILogicBrick::m_sCurrentLogicManager->GetGameObjectByName(STR_String( _PyUnicode_AsString(value) ));"

I ran into this when I removed the logic bricks evaluation. One function which uses this is scene.addObject, which should not rely on Logic bricks for scene -operations.

Simple fix, just ask for the this->GetScene()->GetLogicManager() or something like that, which hides it behind an interface. I'm aware that this isn't a fault with your patch, but this would be a good place to include it, I believe.

@Angus Hollands (agoose77) Those sorts of cleanups are included as part two of the linked proposal. @Jorge Bernal (lordloki), when you get to those changes, make sure to submit them in chunks to code review. I'd rather not try to do code review on all of part two at once.

Adam Friesen (ace_dragon) awarded a token.Jul 22 2014, 9:07 PM

Some of the docs still need their titles renamed.
Revert the style changes to facilitate the review process
Update to current master and fixes to compile

Jorge Bernal (lordloki) updated this object.Nov 23 2014, 7:09 PM

Jorge Bernal (lordloki) edited edge metadata.

Jacob Merrill (blueprintrandom) awarded a token.Nov 23 2014, 11:09 PM

Sybren A. Stüvel (sybren) added a subscriber: Sybren A. Stüvel (sybren).Feb 11 2015, 9:47 PM

Jorge Bernal (lordloki) added a project: Game Engine.May 18 2015, 7:32 AM

Closing. I will follow after UPBGE merge.
Thanks for reviewing

Revision Contents
Changeset List

Path

Size

build_files/

cmake/

macros.cmake

1 line

doc/

python_api/

rst/

bge.logic.rst

72 lines

bge.render.rst

2 lines

bge_types/

bge.types.BL_ActionActuator.rst

bge.types.BL_ArmatureActuator.rst

bge.types.BL_ArmatureObject.rst

2 lines

bge.types.BL_ShapeActionActuator.rst

bge.types.KX_ArmatureSensor.rst

bge.types.KX_CameraActuator.rst

bge.types.KX_ConstraintActuator.rst

bge.types.KX_GameActuator.rst

bge.types.KX_IpoActuator.rst

bge.types.KX_MouseActuator.rst

bge.types.KX_MouseFocusSensor.rst

bge.types.KX_NearSensor.rst

bge.types.KX_NetworkMessageActuator.rst

bge.types.KX_NetworkMessageSensor.rst

bge.types.KX_ObjectActuator.rst

bge.types.KX_ParentActuator.rst

bge.types.KX_RadarSensor.rst

bge.types.KX_RaySensor.rst

bge.types.KX_SCA_AddObjectActuator.rst

bge.types.KX_SCA_DynamicActuator.rst

bge.types.KX_SCA_EndObjectActuator.rst

bge.types.KX_SCA_ReplaceMeshActuator.rst

bge.types.KX_Scene.rst

2 lines

bge.types.KX_SceneActuator.rst

bge.types.KX_SoundActuator.rst

bge.types.KX_StateActuator.rst

bge.types.KX_SteeringActuator.rst

bge.types.KX_TouchSensor.rst

bge.types.KX_TrackToActuator.rst

bge.types.KX_VisibilityActuator.rst

	bge.types.SCA_ActionActuator.rst
	bge.types.BL_ActionActuator.rst

4 lines

	bge.types.SCA_AddObjectActuator.rst
	bge.types.KX_SCA_AddObjectActuator.rst

4 lines

	bge.types.SCA_ArmatureActuator.rst
	bge.types.BL_ArmatureActuator.rst

4 lines

	bge.types.SCA_ArmatureSensor.rst
	bge.types.KX_ArmatureSensor.rst

4 lines

	bge.types.SCA_CameraActuator.rst
	bge.types.KX_CameraActuator.rst

4 lines

	bge.types.SCA_ConstraintActuator.rst
	bge.types.KX_ConstraintActuator.rst

4 lines

	bge.types.SCA_DynamicActuator.rst
	bge.types.KX_SCA_DynamicActuator.rst

4 lines

	bge.types.SCA_EndObjectActuator.rst
	bge.types.KX_SCA_EndObjectActuator.rst

4 lines

	bge.types.SCA_GameActuator.rst
	bge.types.KX_GameActuator.rst

4 lines

	bge.types.SCA_IpoActuator.rst
	bge.types.KX_IpoActuator.rst

4 lines

	bge.types.SCA_MouseActuator.rst
	bge.types.KX_MouseActuator.rst

4 lines

	bge.types.SCA_MouseFocusSensor.rst
	bge.types.KX_MouseFocusSensor.rst

4 lines

	bge.types.SCA_NearSensor.rst
	bge.types.KX_NearSensor.rst

6 lines

	bge.types.SCA_NetworkMessageActuator.rst
	bge.types.KX_NetworkMessageActuator.rst

4 lines

	bge.types.SCA_NetworkMessageSensor.rst
	bge.types.KX_NetworkMessageSensor.rst

4 lines

	bge.types.SCA_ObjectActuator.rst
	bge.types.KX_ObjectActuator.rst

4 lines

	bge.types.SCA_ParentActuator.rst
	bge.types.KX_ParentActuator.rst

4 lines

	bge.types.SCA_RadarSensor.rst
	bge.types.KX_RadarSensor.rst

6 lines

	bge.types.SCA_RaySensor.rst
	bge.types.KX_RaySensor.rst

4 lines

	bge.types.SCA_ReplaceMeshActuator.rst
	bge.types.KX_SCA_ReplaceMeshActuator.rst

4 lines

	bge.types.SCA_SceneActuator.rst
	bge.types.KX_SceneActuator.rst

4 lines

	bge.types.SCA_ShapeActionActuator.rst
	bge.types.BL_ShapeActionActuator.rst

4 lines

	bge.types.SCA_SoundActuator.rst
	bge.types.KX_SoundActuator.rst

4 lines

	bge.types.SCA_StateActuator.rst
	bge.types.KX_StateActuator.rst

4 lines

	bge.types.SCA_SteeringActuator.rst
	bge.types.KX_SteeringActuator.rst

4 lines

	bge.types.SCA_TouchSensor.rst
	bge.types.KX_TouchSensor.rst

4 lines

	bge.types.SCA_TrackToActuator.rst
	bge.types.KX_TrackToActuator.rst

4 lines

	bge.types.SCA_VisibilityActuator.rst
	bge.types.KX_VisibilityActuator.rst

4 lines

source/

blenderplayer/

CMakeLists.txt

1 line

gameengine/

CMakeLists.txt

1 line

Converter/

BL_ActionActuator.h

BL_ActionActuator.cpp

BL_ArmatureActuator.h

BL_ArmatureActuator.cpp

BL_ArmatureObject.h

4 lines

BL_ArmatureObject.cpp

6 lines

BL_DeformableGameObject.h

6 lines

BL_DeformableGameObject.cpp

4 lines

BL_ShapeActionActuator.h

BL_ShapeActionActuator.cpp

CMakeLists.txt

7 lines

KX_BlenderSceneConverter.cpp

6 lines

KX_ConvertActuators.cpp

222 lines

KX_ConvertSensors.cpp

46 lines

GameLogic/

CMakeLists.txt

81 lines

SCA_2DFilterActuator.cpp

2 lines

SCA_IActuator.h

56 lines

SCA_IActuator.cpp

2 lines

SCA_IObject.h

2 lines

SCA_PropertyActuator.h

8 lines

SCA_PropertyActuator.cpp

14 lines

SCA_RandomActuator.h

2 lines

SCA_RandomActuator.cpp

12 lines

	GameLogic/
	Converter/

	SCA_ActionActuator.h
	BL_ActionActuator.h

26 lines

	SCA_ActionActuator.cpp
	BL_ActionActuator.cpp

106 lines

	SCA_ArmatureActuator.h
	BL_ArmatureActuator.h

18 lines

	SCA_ArmatureActuator.cpp
	BL_ArmatureActuator.cpp

58 lines

	SCA_ShapeActionActuator.h
	BL_ShapeActionActuator.h

24 lines

	SCA_ShapeActionActuator.cpp
	BL_ShapeActionActuator.cpp

68 lines

	GameLogic/
	Ketsji/

	SCA_AddObjectActuator.h
	KX_SCA_AddObjectActuator.h

22 lines

	SCA_AddObjectActuator.cpp
	KX_SCA_AddObjectActuator.cpp

64 lines

	SCA_ArmatureSensor.h
	KX_ArmatureSensor.h

16 lines

	SCA_ArmatureSensor.cpp
	KX_ArmatureSensor.cpp

42 lines

	SCA_CameraActuator.h
	KX_CameraActuator.h

18 lines

	SCA_CameraActuator.cpp
	KX_CameraActuator.cpp

58 lines

	SCA_ConstraintActuator.h
	KX_ConstraintActuator.h

20 lines

	SCA_ConstraintActuator.cpp
	KX_ConstraintActuator.cpp

64 lines

	SCA_DynamicActuator.h
	KX_SCA_DynamicActuator.h

20 lines

	SCA_DynamicActuator.cpp
	KX_SCA_DynamicActuator.cpp

39 lines

	SCA_EndObjectActuator.h
	KX_SCA_EndObjectActuator.h

14 lines

	SCA_EndObjectActuator.cpp
	KX_SCA_EndObjectActuator.cpp

28 lines

	SCA_GameActuator.h
	KX_GameActuator.h

18 lines

	SCA_GameActuator.cpp
	KX_GameActuator.cpp

34 lines

	SCA_IpoActuator.h
	KX_IpoActuator.h

30 lines

	SCA_IpoActuator.cpp
	KX_IpoActuator.cpp

86 lines

	SCA_MouseActuator.h
	KX_MouseActuator.h

14 lines

	SCA_MouseActuator.cpp
	KX_MouseActuator.cpp

85 lines

	SCA_MouseFocusSensor.h
	KX_MouseFocusSensor.h

28 lines

	SCA_MouseFocusSensor.cpp
	KX_MouseFocusSensor.cpp

92 lines

	SCA_NearSensor.h
	KX_NearSensor.h

22 lines

	SCA_NearSensor.cpp
	KX_NearSensor.cpp

54 lines

	SCA_NetworkEventManager.h/
	KXNetwork/


	KX_NetworkEventManager.h

18 lines

	SCA_NetworkEventManager.cpp/
	KXNetwork/


	KX_NetworkEventManager.cpp

28 lines

	SCA_NetworkMessageActuator.h/
	KXNetwork/


	KX_NetworkMessageActuator.h

18 lines

	SCA_NetworkMessageActuator.cpp/
	KXNetwork/


	KX_NetworkMessageActuator.cpp

36 lines

	SCA_NetworkMessageSensor.h/
	KXNetwork/


	KX_NetworkMessageSensor.h

22 lines

	SCA_NetworkMessageSensor.cpp/
	KXNetwork/


	KX_NetworkMessageSensor.cpp

54 lines

	SCA_ObjectActuator.h
	KX_ObjectActuator.h

22 lines

	SCA_ObjectActuator.cpp
	KX_ObjectActuator.cpp

137 lines

	SCA_ParentActuator.h
	KX_ParentActuator.h

20 lines

	SCA_ParentActuator.cpp
	KX_ParentActuator.cpp

50 lines

	SCA_RadarSensor.h
	KX_RadarSensor.h

22 lines

	SCA_RadarSensor.cpp
	KX_RadarSensor.cpp

44 lines

	SCA_RayEventManager.h
	KX_RayEventManager.h

16 lines

	SCA_RayEventManager.cpp
	KX_RayEventManager.cpp

8 lines

	SCA_RaySensor.h
	KX_RaySensor.h

16 lines

	SCA_RaySensor.cpp
	KX_RaySensor.cpp

58 lines

	SCA_ReplaceMeshActuator.h
	KX_SCA_ReplaceMeshActuator.h

30 lines

	SCA_ReplaceMeshActuator.cpp
	KX_SCA_ReplaceMeshActuator.cpp

58 lines

	SCA_SceneActuator.h
	KX_SceneActuator.h

20 lines

	SCA_SceneActuator.cpp
	KX_SceneActuator.cpp

54 lines

	SCA_SoundActuator.h
	KX_SoundActuator.h

22 lines

	SCA_SoundActuator.cpp
	KX_SoundActuator.cpp

115 lines

	SCA_StateActuator.h
	KX_StateActuator.h

22 lines

	SCA_StateActuator.cpp
	KX_StateActuator.cpp

42 lines

	SCA_SteeringActuator.h
	KX_SteeringActuator.h

18 lines

	SCA_SteeringActuator.cpp
	KX_SteeringActuator.cpp

86 lines

	SCA_TouchEventManager.h
	KX_TouchEventManager.h

18 lines

	SCA_TouchEventManager.cpp
	KX_TouchEventManager.cpp

54 lines

	SCA_TouchSensor.h
	KX_TouchSensor.h

22 lines

	SCA_TouchSensor.cpp
	KX_TouchSensor.cpp

72 lines

	SCA_TrackToActuator.h
	KX_TrackToActuator.h

20 lines

	SCA_TrackToActuator.cpp
	KX_TrackToActuator.cpp

49 lines

	SCA_VisibilityActuator.h
	KX_VisibilityActuator.h

17 lines

	SCA_VisibilityActuator.cpp
	KX_VisibilityActuator.cpp

38 lines

Ketsji/

CMakeLists.txt

51 lines

KXNetwork/

CMakeLists.txt

KX_NetworkEventManager.h

KX_NetworkEventManager.cpp

KX_NetworkMessageActuator.h

KX_NetworkMessageActuator.cpp

KX_NetworkMessageSensor.h

KX_NetworkMessageSensor.cpp

KX_NetworkObjectActuator.h

KX_NetworkObjectActuator.cpp

KX_NetworkObjectSensor.h

KX_NetworkObjectSensor.cpp

SConscript

KX_ArmatureSensor.h

KX_ArmatureSensor.cpp

KX_CameraActuator.h

KX_CameraActuator.cpp

KX_ConstraintActuator.h

KX_ConstraintActuator.cpp

KX_MouseFocusSensor.h

KX_MouseFocusSensor.cpp

KX_NearSensor.h

KX_NearSensor.cpp

KX_ObjectActuator.h

KX_ObjectActuator.cpp

KX_ParentActuator.h

KX_ParentActuator.cpp

KX_PythonInit.cpp

212 lines

KX_PythonInitTypes.cpp

114 lines

1 line

KX_RayEventManager.cpp

KX_RaySensor.h

KX_RaySensor.cpp

KX_SCA_AddObjectActuator.h

KX_SCA_AddObjectActuator.cpp

KX_SCA_DynamicActuator.h

KX_SCA_DynamicActuator.cpp

KX_SCA_EndObjectActuator.h

KX_SCA_EndObjectActuator.cpp

KX_SCA_ReplaceMeshActuator.h

KX_SCA_ReplaceMeshActuator.cpp

12 lines

KX_SteeringActuator.h

KX_SteeringActuator.cpp

KX_TouchEventManager.h

KX_TouchEventManager.cpp

KX_TouchSensor.h

KX_TouchSensor.cpp

KX_TrackToActuator.h

KX_TrackToActuator.cpp

KX_VisibilityActuator.h

KX_VisibilityActuator.cpp

SConscript

1 line

BGE: Logic Brick clean upAbandonedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 2923

build_files/cmake/macros.cmake

doc/python_api/rst/bge.logic.rst

doc/python_api/rst/bge.render.rst

doc/python_api/rst/bge_types/bge.types.BL_ActionActuator.rst

doc/python_api/rst/bge_types/bge.types.BL_ArmatureActuator.rst

doc/python_api/rst/bge_types/bge.types.BL_ArmatureObject.rst

doc/python_api/rst/bge_types/bge.types.BL_ShapeActionActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_ArmatureSensor.rst

doc/python_api/rst/bge_types/bge.types.KX_CameraActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_ConstraintActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_GameActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_IpoActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_MouseActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_MouseFocusSensor.rst

doc/python_api/rst/bge_types/bge.types.KX_NearSensor.rst

doc/python_api/rst/bge_types/bge.types.KX_NetworkMessageActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_NetworkMessageSensor.rst

doc/python_api/rst/bge_types/bge.types.KX_ObjectActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_ParentActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_RadarSensor.rst

doc/python_api/rst/bge_types/bge.types.KX_RaySensor.rst

doc/python_api/rst/bge_types/bge.types.KX_SCA_AddObjectActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_SCA_DynamicActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_SCA_EndObjectActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_SCA_ReplaceMeshActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_Scene.rst

doc/python_api/rst/bge_types/bge.types.KX_SceneActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_SoundActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_StateActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_SteeringActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_TouchSensor.rst

doc/python_api/rst/bge_types/bge.types.KX_TrackToActuator.rst

doc/python_api/rst/bge_types/bge.types.KX_VisibilityActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_ActionActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_AddObjectActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_ArmatureActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_ArmatureSensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_CameraActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_ConstraintActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_DynamicActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_EndObjectActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_GameActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_IpoActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_MouseActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_MouseFocusSensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_NearSensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_NetworkMessageActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_NetworkMessageSensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_ObjectActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_ParentActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_RadarSensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_RaySensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_ReplaceMeshActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_SceneActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_ShapeActionActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_SoundActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_StateActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_SteeringActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_TouchSensor.rst

doc/python_api/rst/bge_types/bge.types.SCA_TrackToActuator.rst

doc/python_api/rst/bge_types/bge.types.SCA_VisibilityActuator.rst

source/blenderplayer/CMakeLists.txt

source/gameengine/CMakeLists.txt

source/gameengine/Converter/BL_ActionActuator.h

source/gameengine/Converter/BL_ActionActuator.cpp

source/gameengine/Converter/BL_ArmatureActuator.h

source/gameengine/Converter/BL_ArmatureActuator.cpp

source/gameengine/Converter/BL_ArmatureObject.h

source/gameengine/Converter/BL_ArmatureObject.cpp

source/gameengine/Converter/BL_DeformableGameObject.h

source/gameengine/Converter/BL_DeformableGameObject.cpp

source/gameengine/Converter/BL_ShapeActionActuator.h

source/gameengine/Converter/BL_ShapeActionActuator.cpp

source/gameengine/Converter/CMakeLists.txt

BGE: Logic Brick clean up
AbandonedPublic
Actions

Revision Contents
Changeset List