GuiInterface.compassSetIconHost

Sets a Character as host for a world gui

Kind: Function

Environments: Game

Game

Overload 1

guiInterface:compassSetIconHost( host, joint )

Open the full Game reference

Availability: Client only

Parameters:

Name Type Description
gui GuiInterface The Gui interface
host Character The host of the icon
joint (optional) string The joint/bone name (Optional)

Overload 2

guiInterface:compassSetIconHost( iconName, host, joint )

Open the full Game reference

Availability: Client only

Sets a Shape as host for a compass icon

Parameters:

Name Type Description
compassHud GuiInterface The compass hud GUI.
iconName string Name of a compass icon.
host Shape The host of the icon
joint (optional) string The host joint/bone name (Optional)