.. role:: ts-api-decorator

###########
FloorConfig
###########

.. js:module:: Bim
   :noindex:

.. container:: ts-api-section

   .. js:class:: FloorConfig

      Distance configuration used when BIM mode is enabled.
      See also: [[CameraWalkBaseOperator.enableBimMode]].



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~Bim.FloorConfig.avatarOffset`
   * :js:attr:`~Bim.FloorConfig.maxClimbHeight`
   * :js:attr:`~Bim.FloorConfig.maxFallDistance`
   * :js:attr:`~Bim.FloorConfig.negligibleClimbHeight`





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

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: FloorConfig.avatarOffset

      :type: number

      The offset from the floor used for the avatar.



.. container:: ts-api-section

   .. js:attribute:: FloorConfig.maxClimbHeight

      :type: number

      The maximum gain in height the avatar is allowed to scale.



.. container:: ts-api-section

   .. js:attribute:: FloorConfig.maxFallDistance

      :type: number

      The maximum distance the avatar can fall.



.. container:: ts-api-section

   .. js:attribute:: FloorConfig.negligibleClimbHeight

      :type: number

      Any gain in height less than this distance does not cause the avatar to buoy upward.



