AstralTransRocketries/mcedit2
Archived
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Change docstrings to numpydoc

Browse Source
This commit is contained in:
David Vierra 2016-01-31 13:33:05 -10:00
parent 91f9dfa560
commit 3a4751b32a
1 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
src/mcedit2/editortools/__init__.py
View File

@ -62,52 +62,60 @@ class EditorTool(QtCore.QObject):
"""
Initialize toolWidget here.
:type editorSession: EditorSession
Parameters
----------
editorSession: EditorSession
"""
super(EditorTool, self).__init__(*args, **kwargs)
self.editorSession = editorSession
def mousePress(self, event):
"""
:type event: QMouseEvent
event has been augmented with these attributes:
Parameters
----------
event: QMouseEvent
event has been augmented with these attributes:
point, ray, blockPosition, blockFace
"""
def mouseMove(self, event):
"""
:type event: QMouseEvent
event has been augmented
Parameters
----------
event: QMouseEvent
event has been augmented
"""
def mouseDrag(self, event):
"""
:type event: QMouseEvent
Parameters
----------
event has been augmented
event: QMouseEvent
event has been augmented
"""
def mouseRelease(self, event):
"""
:type event: QMouseEvent
Parameters
----------
event has been augmented
event: QMouseEvent
event has been augmented
"""
def toolActive(self):
"""
Called when this tool is selected.
:return:
:rtype:
"""
def toolInactive(self):
"""
Called when a different tool is selected.
:return:
:rtype:
"""
toolPicked = QtCore.Signal(object)