ItemTask

A task for rendering an Item

ItemTask.item

Sets the Item for this task render

overload 1:
                        
ItemTask:item(item)  
 Method Property Fluent Description Representation
item accepts a String String 
   
Return Value a RenderTask RenderTask 
   
overload 2:
                        
ItemTask:item(item)  
 Method Property Fluent Description Representation
item accepts an ItemStack ItemStack 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
item accepts	a String	`String`
Return Value	a RenderTask	`RenderTask`

Method Property	Fluent Description	Representation
item accepts	an ItemStack	`ItemStack`
Return Value	a RenderTask	`RenderTask`

ItemTask.renderType

figura.docs.item_task.set_render_type

overload 1:
                        
ItemTask:renderType(renderType)  
 Method Property Fluent Description Representation
renderType accepts a String String 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
renderType accepts	a String	`String`
Return Value	a RenderTask	`RenderTask`

ItemTask.setRenderType

figura.docs.item_task.set_render_type

overload 1:
                        
ItemTask:setRenderType(renderType)  
 Method Property Fluent Description Representation
renderType accepts a String String 
   
Return Value nil nil

Method Property	Fluent Description	Representation
renderType accepts	a String	`String`
Return Value	nil	`nil`

ItemTask.getRenderType

figura.docs.item_task.get_render_type

overload 1:
                        
ItemTask:getRenderType()  
 Method Property Fluent Description Representation
Return Value a String String

Method Property	Fluent Description	Representation
Return Value	a String	`String`

ItemTask.setItem

Sets the Item for this task render

overload 1:
                        
ItemTask:setItem(item)  
 Method Property Fluent Description Representation
item accepts a String String 
   
Return Value nil nil 
   
overload 2:
                        
ItemTask:setItem(item)  
 Method Property Fluent Description Representation
item accepts an ItemStack ItemStack 
   
Return Value nil nil

Method Property	Fluent Description	Representation
item accepts	a String	`String`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
item accepts	an ItemStack	`ItemStack`
Return Value	nil	`nil`

ItemTask.scale

Inherited from RenderTask

Sets the scale of the task, relative to its attached part

overload 1:
                        
ItemTask:scale(scale)  
 Method Property Fluent Description Representation
scale accepts a Vector3 Vector3 
   
Return Value a RenderTask RenderTask 
   
overload 2:
                        
ItemTask:scale(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
scale accepts	a Vector3	`Vector3`
Return Value	a RenderTask	`RenderTask`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	a RenderTask	`RenderTask`

ItemTask.enabled

Inherited from RenderTask

figura.docs.render_task.set_enabled

overload 1:
                        
ItemTask:enabled(bool)  
 Method Property Fluent Description Representation
bool accepts a Boolean Boolean 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
bool accepts	a Boolean	`Boolean`
Return Value	a RenderTask	`RenderTask`

ItemTask.pos

Inherited from RenderTask

Sets the position of the task, relative to its attached part
Uses model coordinates

overload 1:
                        
ItemTask:pos(pos)  
 Method Property Fluent Description Representation
pos accepts a Vector3 Vector3 
   
Return Value a RenderTask RenderTask 
   
overload 2:
                        
ItemTask:pos(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
pos accepts	a Vector3	`Vector3`
Return Value	a RenderTask	`RenderTask`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	a RenderTask	`RenderTask`

ItemTask.isEnabled

Inherited from RenderTask

figura.docs.render_task.is_enabled

overload 1:
                        
ItemTask:isEnabled()  
 Method Property Fluent Description Representation
Return Value a Boolean Boolean

Method Property	Fluent Description	Representation
Return Value	a Boolean	`Boolean`

ItemTask.setScale

Inherited from RenderTask

Sets the scale of the task, relative to its attached part

overload 1:
                        
ItemTask:setScale(scale)  
 Method Property Fluent Description Representation
scale accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
ItemTask:setScale(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
scale accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ItemTask.getRot

Inherited from RenderTask

Gets this task rotation

overload 1:
                        
ItemTask:getRot()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ItemTask.getPos

Inherited from RenderTask

Gets this task position

overload 1:
                        
ItemTask:getPos()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ItemTask.setRot

Inherited from RenderTask

Sets the rotation of the task, relative to its attached part

overload 1:
                        
ItemTask:setRot(rot)  
 Method Property Fluent Description Representation
rot accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
ItemTask:setRot(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
rot accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ItemTask.setPos

Inherited from RenderTask

Sets the position of the task, relative to its attached part
Uses model coordinates

overload 1:
                        
ItemTask:setPos(pos)  
 Method Property Fluent Description Representation
pos accepts a Vector3 Vector3 
   
Return Value nil nil 
   
overload 2:
                        
ItemTask:setPos(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value nil nil

Method Property	Fluent Description	Representation
pos accepts	a Vector3	`Vector3`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
x accepts	a Number	`Number`
y accepts	a Number	`Number`
z accepts	a Number	`Number`
Return Value	nil	`nil`

ItemTask.getOverlay

Inherited from RenderTask

Returns the overlay override value of this task

overload 1:
                        
ItemTask:getOverlay()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

ItemTask.getLight

Inherited from RenderTask

Returns the light override value of this task

overload 1:
                        
ItemTask:getLight()  
 Method Property Fluent Description Representation
Return Value a Vector2 Vector2

Method Property	Fluent Description	Representation
Return Value	a Vector2	`Vector2`

ItemTask.setOverlay

Inherited from RenderTask

Sets the overlay override value of this task
Values you give are 0 to 15, indicating the white overlay and the damage overlay levels you want to use
Passing nil will reset the overlay override for this task

overload 1:
                        
ItemTask:setOverlay(overlay)  
 Method Property Fluent Description Representation
overlay accepts a Vector2 Vector2 
   
Return Value nil nil 
   
overload 2:
                        
ItemTask:setOverlay(whiteOverlay, hurtOverlay)  
 Method Property Fluent Description Representation
whiteOverlay accepts an Integer Integer 
   
hurtOverlay accepts an Integer Integer 
   
Return Value nil nil

Method Property	Fluent Description	Representation
overlay accepts	a Vector2	`Vector2`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
whiteOverlay accepts	an Integer	`Integer`
hurtOverlay accepts	an Integer	`Integer`
Return Value	nil	`nil`

ItemTask.setLight

Inherited from RenderTask

Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task

overload 1:
                        
ItemTask:setLight(light)  
 Method Property Fluent Description Representation
light accepts a Vector2 Vector2 
   
Return Value nil nil 
   
overload 2:
                        
ItemTask:setLight(blockLight, skyLight)  
 Method Property Fluent Description Representation
blockLight accepts an Integer Integer 
   
skyLight accepts an Integer Integer 
   
Return Value nil nil

Method Property	Fluent Description	Representation
light accepts	a Vector2	`Vector2`
Return Value	nil	`nil`

Method Property	Fluent Description	Representation
blockLight accepts	an Integer	`Integer`
skyLight accepts	an Integer	`Integer`
Return Value	nil	`nil`

ItemTask.overlay

Inherited from RenderTask

overload 1:
                        
ItemTask:overlay(overlay)  
 Method Property Fluent Description Representation
overlay accepts a Vector2 Vector2 
   
Return Value a RenderTask RenderTask 
   
overload 2:
                        
ItemTask:overlay(whiteOverlay, hurtOverlay)  
 Method Property Fluent Description Representation
whiteOverlay accepts an Integer Integer 
   
hurtOverlay accepts an Integer Integer 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
overlay accepts	a Vector2	`Vector2`
Return Value	a RenderTask	`RenderTask`

Method Property	Fluent Description	Representation
whiteOverlay accepts	an Integer	`Integer`
hurtOverlay accepts	an Integer	`Integer`
Return Value	a RenderTask	`RenderTask`

ItemTask.light

Inherited from RenderTask

Sets the light override value of this task
Values are given from 0 to 15, indicating the block light and sky light levels you want to use
Passing nil will reset the lighting override for this task

overload 1:
                        
ItemTask:light(light)  
 Method Property Fluent Description Representation
light accepts a Vector2 Vector2 
   
Return Value a RenderTask RenderTask 
   
overload 2:
                        
ItemTask:light(blockLight, skyLight)  
 Method Property Fluent Description Representation
blockLight accepts an Integer Integer 
   
skyLight accepts an Integer Integer 
   
Return Value a RenderTask RenderTask

Method Property	Fluent Description	Representation
light accepts	a Vector2	`Vector2`
Return Value	a RenderTask	`RenderTask`

Method Property	Fluent Description	Representation
blockLight accepts	an Integer	`Integer`
skyLight accepts	an Integer	`Integer`
Return Value	a RenderTask	`RenderTask`

ItemTask.getScale

Inherited from RenderTask

Gets this task scale

overload 1:
                        
ItemTask:getScale()  
 Method Property Fluent Description Representation
Return Value a Vector3 Vector3

Method Property	Fluent Description	Representation
Return Value	a Vector3	`Vector3`

ItemTask.setEnabled

Inherited from RenderTask

figura.docs.render_task.set_enabled

overload 1:
                        
ItemTask:setEnabled(bool)  
 Method Property Fluent Description Representation
bool accepts a Boolean Boolean 
   
Return Value nil nil

Method Property	Fluent Description	Representation
bool accepts	a Boolean	`Boolean`
Return Value	nil	`nil`

ItemTask.rot

Inherited from RenderTask

Sets the rotation of the task, relative to its attached part

overload 1:
                        
ItemTask:rot(rot)  
 Method Property Fluent Description Representation
rot accepts a Vector3 Vector3 
   
Return Value a RenderTask RenderTask 
   
overload 2:
                        
ItemTask:rot(x, y, z)  
 Method Property Fluent Description Representation
x accepts a Number Number 
   
y accepts a Number Number 
   
z accepts a Number Number 
   
Return Value a RenderTask RenderTask

Global Objects

Miscellaneous Types

Miscelanous

action_wheel

animations

nameplate

world

vanilla_model

models

player

events

keybinds

vectors

matrices

particles

sounds

pings

textures

Miscellaneous Enums

ItemTask

ItemTask.item

ItemTask.renderType

ItemTask.setRenderType

ItemTask.getRenderType

ItemTask.setItem

ItemTask.scale

ItemTask.enabled

ItemTask.pos

ItemTask.isEnabled

ItemTask.setScale

ItemTask.getRot

ItemTask.getPos

ItemTask.setRot

ItemTask.setPos

ItemTask.getOverlay

ItemTask.getLight

ItemTask.setOverlay

ItemTask.setLight

ItemTask.overlay

ItemTask.light

ItemTask.getScale

ItemTask.setEnabled

ItemTask.rot