PcoWSkbVqDnWTu_dm2ix
The Developer Hub is now deprecated and information on this page may no longer be accurate. To see our new and improved documentation, please click here. You can read more about the future of documentation here.
Collapse Sidebar

SetTextureOffset

Sets the current offset of the Beam’s texture cycle.

The offset of a Beams texture cycle represents the progress of the Beams texture animation. Hence, a Beam’s texture cycle can be reset as follows:

beam:SetTextureOffset(0)

Where manual control is not required over the Beam’s texture cycle, Beam/TextureSpeed can be used instead to animate the Beam. Although, for illustrative purposes, a similar function can be achieved with SetTextureOffset.

local RunService = game:GetService("RunService")
while true do
	for i = 1, 0, -0.01 do
		RunService.RenderStepped:Wait()
		beam:SetTextureOffset(i)
	end	
end

Notes

  • The given offset parameter is expected to be a value between 0 and 1, but greater values can still be used
  • The texture cycle wraps at 0 and 1, meaning the texture is in the same position when the offset is 0 or at 1
  • If the Beam/Texture property is not set, this function will do nothing
  • Increasing the offset will act in the inverse direction to the Beam/TextureSpeed property. Meaning, it will move the texture in the opposite direction to the direction the texture animates when Beam/TextureSpeed is more than 0

Parameters

Name Type Default Description
0

The desired offset of the texture cycle.

Returns

Return Type Summary