.. role:: ts-api-decorator

#################
FloorplanOperator
#################

.. js:module:: Operators
   :noindex:

.. container:: ts-api-section

   .. js:class:: FloorplanOperator



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-class

   * :js:meth:`~Operators.FloorplanOperator.addMapping`
   * :js:meth:`~Operators.FloorplanOperator.clearMapping`
   * :js:meth:`~Operators.FloorplanOperator.restrictToAvatar`
   * :js:meth:`~Operators.FloorplanOperator.setMapping`





------------

Methods
=======

.. rst-class:: ts-api-section

addMapping
----------

.. js:method:: FloorplanOperator.addMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid.
   All mappings require a mouse button, but a key modifier is optional.


   :rtype: void

.. rst-class:: ts-api-section

clearMapping
------------

.. js:method:: FloorplanOperator.clearMapping()



   Clears any button and key modifier mappings for the operator.


   :rtype: void

.. rst-class:: ts-api-section

restrictToAvatar
----------------

.. js:method:: FloorplanOperator.restrictToAvatar( restrict)

   :param restrict: None
   :type restrict: boolean


   Set whether or not dragging is restricted to the avatar. If true the operator will only function if
   the selection begins on the avatar


   :rtype: void

.. rst-class:: ts-api-section

setMapping
----------

.. js:method:: FloorplanOperator.setMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Sets the button and key modifier mapping for the operator.


   :rtype: void

