Client Exports

All the client exports that are accessible from other resources

Client Exports

Function: AddSpriteInteractionModel(entity, args)

Adds a sprite interaction model to a specified entity.

Parameters:

  • entity: The entity to which the sprite interaction model will be added. Can be a string or a hash key.

  • args: A table containing the following optional parameters:

    • textureName: The name of the texture dictionary.

    • spriteName: The name of the sprite.

    • interactionName: A unique name for the interaction.

    • spriteX: The X scale of the sprite.

    • spriteY: The Y scale of the sprite.

    • offsetX: The X offset of the sprite.

    • offsetY: The Y offset of the sprite.

    • offsetZ: The Z offset of the sprite.

    • spriteAlpha: The alpha (transparency) of the sprite.

    • key: The key to trigger the interaction.

    • distance: The distance within which the interaction can be triggered.

    • action: The function to execute when the interaction is triggered.

Function: AddSpriteInteractionCoords(coords, args)

Adds a sprite interaction at specified coordinates.

Parameters:

  • coords: The coordinates where the sprite interaction will be added.

  • args: A table containing the following optional parameters:

    • textureName: The name of the texture dictionary.

    • spriteName: The name of the sprite.

    • interactionName: A unique name for the interaction.

    • spriteX: The X scale of the sprite.

    • spriteY: The Y scale of the sprite.

    • offsetX: The X offset of the sprite.

    • offsetY: The Y offset of the sprite.

    • offsetZ: The Z offset of the sprite.

    • spriteAlpha: The alpha (transparency) of the sprite.

    • key: The key to trigger the interaction.

    • distance: The distance within which the interaction can be triggered.

    • action: The function to execute when the interaction is triggered.

Function: HideSpriteInteraction(intName, toggle)

Hides or shows a sprite interaction.

Parameters:

  • intName: The name of the interaction to hide or show.

  • toggle: A boolean value to hide (true) or show (false) the interaction.

Function: AddInteractionCoords(coords, args)

Adds an interaction at specified coordinates.

Parameters:

  • coords: The coordinates where the interaction will be added.

  • args: A table containing the following parameters:

    • distance: The distance within which the interaction can be triggered.

    • offset: The offset for the interaction label and target.

    • checkVisibility: A boolean to check if the interaction is visible.

    • name: The unique name for the interaction.

    • action: The function to execute when the interaction is triggered.

    • key: The key to trigger the interaction.

    • label: The label for the interaction.

    • duration: The duration of the interaction.

    • icon: The icon for the interaction.

Function: AddInteractionEntity(entity, args)

Adds an interaction to a specified entity.

Parameters:

  • entity: The entity to which the interaction will be added.

  • args: A table containing the following parameters:

    • distance: The distance within which the interaction can be triggered.

    • offset: The offset for the interaction label and target.

    • checkVisibility: A boolean to check if the interaction is visible.

    • name: The unique name for the interaction.

    • action: The function to execute when the interaction is triggered.

    • key: The key to trigger the interaction.

    • label: The label for the interaction.

    • duration: The duration of the interaction.

    • icon: The icon for the interaction.

Function: AddInteractionEntityMultiple(entity, args)

Adds multiple interactions to a specified entity.

Parameters:

  • entity: The entity to which the interactions will be added.

  • args: A table containing the following parameters:

    • distance: The distance within which the interactions can be triggered.

    • checkVisibility: A boolean to check if the interactions are visible.

    • offset: The offset for the interaction label and target.

    • interaction: A table containing multiple interaction definitions, each with:

      • name: The unique name for the interaction.

      • action: The function to execute when the interaction is triggered.

      • key: The key to trigger the interaction.

      • label: The label for the interaction.

      • duration: The duration of the interaction.

      • icon: The icon for the interaction.

Function: RemoveInteraction(handler, unique_name)

Removes an interaction by its handler and unique name.

Parameters:

  • handler: The handler of the interaction to remove.

  • unique_name: The unique name of the interaction to remove.

Function: RemoveInteractionByName(name)

Removes an interaction by its name.

Parameters:

  • name: The name of the interaction to remove.

Function: AddInteractionModel(entity, opts)

Adds an interaction model to a specified entity.

Parameters:

  • entity: The entity to which the interaction model will be added. Can be a string or a hash key.

  • opts: A table containing the options for the interaction model, including:

    • CheckVisibility: A boolean to check if the interaction is visible.

    • distance: The distance within which the interaction can be triggered.

    • offset: The offset for the interaction label and target.

    • Name: The name of the interaction.

    • Icon: The icon for the interaction.

    • Label: The label for the interaction.

    • Key: The key to trigger the interaction.

    • Duration: The duration of the interaction.

    • Action: The function to execute when the interaction is triggered.

PreviousKF_InteractionsNextKF_Video

Last updated