Effect.setHost
Sets a Interactable as host for an effect.
Kind: Function
Environments: Game
Game
Overload 1
effect:setHost( Interactable, boneName )
Availability: Client only
Parameters:
| Name | Type | Description |
|---|---|---|
effect |
Effect | The effect. |
Interactable |
Interactable | The Interactable the effect is attached to. |
boneName (optional) |
string | The bone name to attach effect to. (Defaults to not attached to a bone) (Optional) |
Overload 2
effect:setHost( shape, boneName )
Availability: Client only
Sets a Shape as host for an effect.
Parameters:
| Name | Type | Description |
|---|---|---|
effect |
Effect | The effect. |
shape |
Shape | The shape the effect is attached to. |
boneName (optional) |
string | The bone name to attach effect to. (Defaults to not attached to a bone) (Optional) |
Overload 3
effect:setHost( Character, boneName )
Availability: Client only
Sets a Character as host for an effect.
Parameters:
| Name | Type | Description |
|---|---|---|
effect |
Effect | The effect. |
Character |
Character | The Character the effect is attached to. |
boneName (optional) |
string | The bone name to attach effect to. (Defaults to not attached to a bone) (Optional) |
Overload 4
effect:setHost( pHarvestable, boneName )
Availability: Client only
Sets a Harvestable as host for an effect.
Parameters:
| Name | Type | Description |
|---|---|---|
effect |
Effect | The effect. |
pHarvestable |
Harvestable | The pHarvestable the effect is attached to. |
boneName (optional) |
string | The bone name to attach effect to. (Defaults to not attached to a bone) (Optional) |