Yuari
Documentation
Docs/Instances/InputHoldBegin / InputHoldEnd

InputHoldBegin / InputHoldEnd

Calls the instance InputHold bound functions through the call gate.

Syntax

inst:InputHoldBegin() -> boolean
inst:InputHoldEnd() -> boolean

Parameters

This function takes no parameters.

Returns

TypeDescription
booleanTrue when the engine call succeeded.

Description

The methods resolve the game’s own InputHoldBegin and InputHoldEnd bound functions and invoke them with the instance as self.

These are the same primitives used internally by fireproximityprompt.

Example

local prompt = workspace:FindFirstChildWhichIsA("ProximityPrompt", true)
if prompt then
    prompt:InputHoldBegin()
    task.wait(0.2)
    prompt:InputHoldEnd()
end

Notes

  • Returns false when the instance is invalid or the bound function cannot be resolved.
  • Primarily useful on ProximityPrompt objects.