Dota 2 Workshop Tools/Scripting/API/Global.LinkLuaModifier: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
Line 12: Line 12:




;Example
;Examples
Note: ''modifier_pudge_meat_hook.lua located in \vscripts\''
<source lang="lua">
<source lang="lua">
LinkLuaModifier( "modifier_pudge_meat_hook", LUA_MODIFIER_MOTION_HORIZONTAL)
LinkLuaModifier( "modifier_pudge_meat_hook", LUA_MODIFIER_MOTION_HORIZONTAL )
unit:AddNewModifier(source, ability, "modifier_pudge_meat_hook", {})
</source>
 
 
Note: ''modifier_filepath_test.lua located in \vscripts\test\''
<source lang="lua">
LinkLuaModifier( "modifier_filepath_test", "test/modifier_filepath_test", LUA_MODIFIER_MOTION_NONE )
unit:AddNewModifier(source, ability, "modifier_filepath_test", {})
</source>
</source>



Revision as of 10:44, 27 June 2015

Note.pngNote: This page is automatically generated. Any changes may be overwritten

Function Description

void LinkLuaModifier(string modifier_name, string file_path, int motion_controller_type)

Link a lua-defined modifier with the associated class. If the modifier is located within the root vscript folder, then the second argument (file_path) may be omitted'


Examples

Note: modifier_pudge_meat_hook.lua located in \vscripts\

LinkLuaModifier( "modifier_pudge_meat_hook", LUA_MODIFIER_MOTION_HORIZONTAL )
unit:AddNewModifier(source, ability, "modifier_pudge_meat_hook", {})


Note: modifier_filepath_test.lua located in \vscripts\test\

LinkLuaModifier( "modifier_filepath_test", "test/modifier_filepath_test", LUA_MODIFIER_MOTION_NONE )
unit:AddNewModifier(source, ability, "modifier_filepath_test", {})

Parameters

Type Name Description
string modifier_name Name to be registered for the modifier, to be used when adding it.
string file_path File path of the .lua file containing the code for the modifier.
int motion_controller_type The type of motion controller(s) to be registered by this modifier

LUA_MODIFIER_MOTION_NONE

LUA_MODIFIER_MOTION_HORIZONTAL

LUA_MODIFIER_MOTION_VERTICAL

LUA_MODIFIER_MOTION_BOTH

LUA_MODIFIER_INVALID