Skip to main content

Interaction Types (Unity)

Below is a list of all interactions already defined in Unity, including their function and usage:

ChangeCharacteristicChoice​

Sets a CharacteristicChoice based on a Choice (from a Characteristic or CharacteristicCombination) and sends this value to the frontend.

Required InteractionParameter Types:​

  • Choice
    Indicates which Characteristic/Choice this interaction responds to.
    Important: The value must be a HEX value.

  • CodeParameterPair
    Code: TargetProductCharacteristic (Required)
    Indicates which ProductCharacteristic the choice is applied to.

Example:​

CodeTypeParameter
Pref_ELA_Side_B_P_DR10_CCCH_CHCharacteristicCombinationChoiceCont_Frame_CP
TargetProductCharacteristicCodeParameterPairCON_BRE

ChangeColor​

Changes the color of a GameObject. The specific color is determined by the corresponding Choice.

Important: The value must currently be a HEX code (e.g. #FF00FF).
Alpha transparency is supported with two extra HEX digits (e.g. #FF00FF71).
00 = fully transparent, FF = opaque.

Required InteractionParameter Types:​

  • Choice
    See above.

  • GameObjectName
    Specifies on which mesh inside the ObjectInformation the color should be applied.
    Path: Folder01/Sub-Folder02/MeshName

Example:​

CodeTypeParameter
Pref_ELA_Side_B_P_DR10_CC_CHChoiceELA_CONT_OUT_COLOR
Pref_ELA_Side_F_P_DL10_CC_GONGameObjectNameStirnwand TL Li-B1000-P-LRH2,5-MWSCH/0/0/Color01

ChangeIntensity​

Changes the light intensity.

Important: The value is a float between 0.1 and 2.

Required InteractionParameter Types:​

  • Choice
    See above.

  • GameObjectName
    Path relative to the ObjectInformation.

Example:​

CodeTypeParameter
PRE_TX_JV_50_LIGHTSOURCEChoiceTX_VX_JV_LICHTINTENSITÄT
Pref_ELA_Side_F_P_DL10_CI_GONGameObjectNameJV50/LED/LIGHTSOURCE

ChangeLightColor​

Changes the light color of a light source.

Important: The value must be a HEX code.

Required InteractionParameter Types:​

  • Choice
    See above.

  • GameObjectName
    Path relative to the ObjectInformation.

Example:​

CodeTypeParameter
Pref_ELA_Side_B_P_DR10_CLC_CHChoiceTX_VC_LICHTFARBE
Pref_ELA_Side_F_P_DL10_CLC_GONGameObjectNamePRE_TX_JV_Jovie50/Body/LightSource/01

ChangeMaterial​

Changes the material of a GameObject.

Required InteractionParameter Types:​

  • Choice
    The value must exactly match a material name in the Addressables.

  • GameObjectName
    Path relative to the ObjectInformation.

Example:​

CodeTypeParameter
FC_PPS_Body_BodyM_CM_CHChoiceFC_BARREL_SURFACE
FC_PPS_Body_BodyM_CM_GONGameObjectNameBody_M/BodyMesh

ChangePosition​

Allows you to overwrite the position of an ObjectInformation / GameObject.

Required InteractionParameter Types:​

  • Choice
    Value must be formatted as Vector3 (e.g. 0.2;0;13).

  • GameObjectName (optional)
    If not defined, the position is applied to the ObjectInformation itself.

Example:​

CodeTypeParameter
Pref_ELA_Side_B_P_DR10_CLC_CHCharacteristicCombinationChoiceELA_TUERPOS_01
Pref_ELA_Side_F_P_DL10_CLC_GONGameObjectName0/TuerMesh

ChangePrefab​

Loads and spawns GameObjects from the Addressables.

Required InteractionParameter Types:​

  • Choice
    Must exactly match a prefab name.

  • CodeParameterPair

    • PrefabContainerPath
    • DefaultPrefab (optional)
    • PrefabContainerPosition (optional, default 0;0;0)
    • PrefabContainerRotation (optional, default 0;0;0)
    • PrefabContainerScale (optional, default 1;1;1)

Example:​

CodeTypeParameter
Pref_ELA_Door_B_CHChoiceELA_CONT_WALL_B_DOOR
PrefabContainerPathCodeParameterPairDoor_B
DefaultPrefabCodeParameterPairOutSideDoor
PrefabContainerPositionCodeParameterPair-1.705;0.144;-6.045
PrefabContainerRotationCodeParameterPair0;180;0
PrefabContainerScaleCodeParameterPair1;1;1

ChangeRotation​

→ In Planning

ChangeScale​

→ In Planning

ChangeTexture​

Changes the texture of a GameObject.

Required InteractionParameter Types:​

  • Choice
    e.g. TEX_SB_Carbon

  • GameObjectName
    Path relative to the ObjectInformation.

Example:​

CodeTypeParameter
PRE_SB_Model_01_CHCharacteristicCombinationChoiceSB_BODY_TEXTURE
PRE_SB_Model_01_GONGameObjectNameBODY/Mesh01

ChangeVisibility​

Shows or hides a GameObject depending on whether its name matches the current Choice.

Required InteractionParameter Types:​

  • Choice
    Must exactly match the GameObject name.

  • GameObjectName
    Path relative to the ObjectInformation.

Example:​

CodeTypeParameter
Pref_ELA_Side_B_P_DR10_CV_CHChoiceELA_CONT_WALL_B
Pref_ELA_Side_B_P_DR10_CV_GONGameObjectNameStirnwand TL Re-B1000-P-LRH2,5-MWSCH

Dimensioning​

Displays dimensions on a Box-Collider.

Currently no parameters required.

ElineOutline​

Adds an outline to a GameObject.

Required InteractionParameter Types:​

  • GameObjectName (optional, default = current ObjectInformation)

  • CodeParameterPair

    • ElineObjectType (optional, default = ActiveModule)
      Possible values:
      • ActiveModule
      • Head
      • Pusher
      • Mount
      • TP

Example:​

CodeTypeParameter
PRE_TX_YNS_LE_650_OutL_GONGameObjectName0/TuerMesh
ElineObjectTypeCodeParameterPairActiveModule

FlagInformationComponent​

Controls whether and how the Product interacts with the Scene.

Required InteractionParameter Types:​

  • CodeParameterPair
    • UseGridSystem: true / false
    • IsPlaceableInsideObject: true / false

Example:​

CodeTypeParameter
UseGridSystemCodeParameterPairfalse
IsPlaceableInsideObjectCodeParameterPairtrue

IgnoreComponent​

Allows you to ignore a Product in the system configuration.

Currently no parameters required.

Minimap​

Adds a minimap to the visualization.

Required InteractionParameter Types:​

  • CodeParameterPair
    • MinimapUIPrefabTextureGameObjectPath
    • CanvasGameObjectName
    • MinimapCameraGameObjectName
    • RenderTextureWidth
    • RenderTextureHeight
    • ViewportGameObjectName
    • ViewportMaterialResourcePath
    • ViewportColor
    • ViewportOutlineWidth
    • ViewportOutlineColor

Example:​

CodeTypeParameter
MinimapUIPrefabTextureGameObjectPathCodeParameterPair[PathName of the MinimapTexture]
CanvasGameObjectNameCodeParameterPair[CanvasName]
MinimapCameraGameObjectNameCodeParameterPair[MiniMapCameraName]
RenderTextureWidthCodeParameterPair[Texture Width]
RenderTextureHeightCodeParameterPair[Texture Height]
ViewportGameObjectNameCodeParameterPair[MinimapFrameName]
ViewportMaterialResourcePathCodeParameterPair[MaterialPathName]
ViewportColorCodeParameterPair[ViewPortColor]
ViewportOutlineWidthCodeParameterPair[ViewPortOutLineThickness]
ViewportOutlineColorCodeParameterPair[ViewPortOutLineColor]

PositionInformation​

Creates a position info element for the frontend.

Required InteractionParameter Types:​

  • CodeParameterPair
    • ProductCharacteristicName (optional, default = "Developer Magic")

Example:​

CodeTypeParameter
ProductCharacteristicNameCodeParameterPair[ProductCharacteristicName]

SnappableContainer​

Defines the Parent-/Container-SnapPointCategory.

Required InteractionParameter Types:​

  • CodeParameterPair
    • Category

Example:​

CodeTypeParameter
CategoryCodeParameterPair[PARENT-SnapPointCategory]

SnappableObject​

Defines the Child-/Object-SnapPointCategory.

Required InteractionParameter Types:​

  • CodeParameterPair
    • ContainerCategory
    • Category

Example:​

CodeTypeParameter
CategoryCodeParameterPair[CHILD-SnapPointCategory]
ContainerCategoryCodeParameterPair[PARENT-SnapPointCategory]

SubProductQuantityInformation​

Allows adding sub-products with defined quantity to a product.

Example for a furniture package:

  • 2x tables
  • 8x chairs
  • 2x cabinets
  • 1x trash bin

Required InteractionParameter Types:​

  • CodeParameterPair
    • ProductCode
      Must match an existing ProductCode.
    • Quantity
      Quantity of the product.

Example:​

CodeTypeParameter
ProductCodeCodeParameterPair[ProductCode]
QuantityCodeParameterPair[QTY]