documentation

few words ...

I tried to describe everything that can be hard to understand even tho most of things have self explanatory names. On top of that there are some comments in various parts of code, mainly initialization if you would like to customize how it builds the dialogs.
Btw. don't bother with English typos ;)

functions descryptions

NTS Create Talent Tree (advanced)

parameter nametypedescription
tree indexintegertree index. is used everywhere for identification
tree rowsintegeramount of rows in tree
tree columnsintegeramount of columns in tree
tree namestringname/title of tree. displayed in middle top
tree subnamesstringsub names/titles. displayed below tree name. use | to separate names
tree available talent points share groupintegerthis is index of group with which this tree will share available talent points. Any modification to one's points will reflect in all other trees with same share group
dialog widthintegerwidth of tree dialog
dialog heightintegerheight of tree dialog
dialog buttons widthintegerwidth of talent buttons
dialog buttons heightintegerheight of talent buttons
dialog buttons autosizeBooleantrue will attempt to size buttons for entire available buttons space
dialog buttons autosize scalerealscale of autosized buttons. 1 will fill 100% area where 0.5 will fill 50% area leaving spaces between buttons
dialog buttons autosize to rectangleBooleantrue will autosize buttons to rectangle using whichever is smaller height or width.
dialog imagefile - imageimage used for dialog itself so it should be some border type image
content offset verticallyintegerleft and right offsets for tree content
content offset horizontallyintegertop and bottom offsets for tree content
tree background imagefile - imagebackground image for tree. Not dialog's image
tree background image tintcolortint of background image
tree background image transparencyrealtransparency of background image
tree background image offsets verticalintegerleft and right offsets of background. Not affected by content offsets
tree background image offsets horizontalintegertop and bottom offsets of background. Not affected by content offsets
tree background image tiledBooleantiled option for background image
tree name stylestringname of style used in tree name
tree name colorcolorcolor used in tree name
tree name label heightintegerheight of label for tree name. Used in correct positioning so make it appropriate to used style size
tree subnames stylestringname of style used in tree sub names
tree subnames colorcolorcolor used in tree sub names. If you want separate color you can use color tags in sub names
tree subnames labels heightintegerheight of label for tree sub names. Used in correct positioning so make it appropriate to used style size
available points label enabledBooleantrue will show available points text in tree
available points label textstringtext of label. #POINTS tag will be replaced with available points amount
available points label stylestringname of style used in label
available points label color over 0colorcolor of text when amount of points is more than 0
available points label color 0colorcolor of text when amount of points is 0
available points label anchorpreset - anchoranchor used for label
available points label offset XintegerX offset of label
available points label offset YintegerY offset of label
talents level label stylestringname of style used in label which is on talent button showing current/max level
talents level label text color over 0colorcolor of text when current level is more than 0
talents level label text color 0colorcolor of text when current level is 0
talents level label back color 1colorcolor of image1 which is combined with image2 to create label background
talents level label back color 2colorcolor of image2 which is combined with image1 to create label background
talents tooltip stylestringname of style used in talent tooltips description
talents tooltip values colorcolorcolor of parsed values in tooltip
talents name stylestringname of style used in tooltip for talent name
talents name learnable colorcolorcolor for talent name when talent is learn able
talents name not learnable colorcolorcolor for talent name when talent is not learn able
talent back imagefile - imageimage which is behind talent button. for decoration
talent back image can learn tintcolortint of image when talent is learn able
talent back image can't learn tintcolortint of image when talent is not learn able
talent back image transparencyrealtransparency if image
talent back image scale to button horizontallyrealscale to button of image horizontally
talent back image scale to button verticallyrealscale to button of image vertically
new learnable talent back imagefile - imagethis image will be shown when talent is learn able for the first time or in other word: is just unlocked.
new learnable talent back image tintcolortint of image
new learnable talent back image transparencyrealtransparency of image
new learnable talent back image scale to button horizontallyrealscale to button of image horizontally
new learnable talent back image scale to button verticallyrealscale to button of image vertically
requirement arrow imagefile - imageimage of arrow tho can be anything. This is used to visualize requirement
requirement arrow thicknessintegertechnically height of image
requirement arrow offsetintegeroffset from start of arrow drawing. This may require some trial & error (see picture on main page)
requirement arrow tiledBooleantiled option for image
requirement arrow blend modepreset - dialog blend modeblend mode for image
requirement arrow color enabledcolortint of image when active, meaning talent can be learn or is learned.
requirement arrow color disabledcolortint of image when not active


NTS Create Talent

parameter nametypedescription
linked upgradegame link - upgradeupgrade to which this talent is linked. upgrade level = talent level Note: You don't need to assign upgrade, so you can make dummy talent because it uses own level memory.
parent tree indexintegerindex of tree to which this talent belongs to
talent namestringname of talent
talent rowintegerrow position within the tree
talent columnintegercolumn position within the tree
talent max levelintegermax level of talent
talent costintegertalent points cost of talent
talent imagefile - imagetalent image :)
talent image learnable tintcolortint of image when talent is learn able
talent image not learnable tintcolortint of image when talent is not learn able
talent lore descriptionstringdescription visible in talent tooltip. For example something like: "Summons powerful fireball..."
talent stats descriptionstringdescription visible in talent tooltip. Shown after lore description. Use values between { and }. for example {5} for level 1 will result in 5 where for level 2 in 10. You can use real values. for % simply use {5.0}%. Fraction character is dot
required talent tree indexintegerindex of tree for required talent
required talent rowintegerrow of required talent. Note: you may use it before given talent is create prior to initialization
required talent columnintegercolumn of required talent. Note: you may use it before given talent is create prior to initialization
required talent levelintegerlevel of required talent. Note: 0 will cause this to be ignored and talent initially learnable unless 'required tree total levels' is more than 0
required tree total levelsintegerrequired amount of points in 'required talent tree index' tree. Note: 0 will cause this to be ignored and talent initially learnable unless 'required talent level' is more than 0
requirement arrow enabledBooleantrue will cause arrow to be drawn. This will ignore trees with other index (obviously) and will attempt to hook to required talent in current tree so double check this

NTS Initialize

parameter nametypedescription
require talent cost points msgstringmessage displayed when can't learn talent due insufficient talent points. Use #COST tag for cost value, #S for 's' if value is more than 1
require points in required talent msgstringmessage displayed when can't learn due insufficient levels in required talent. Use #RVAL tag for amount of levels/points required, #RTALENT tag for name of required talent, #S for 's' if value is more than 1
require points in required tree msgstringmessage displayed when can't learn due insufficient point in tree. Use #RVAL tag for amount of levels/points required, #RTREE tag for tree name, #S for 's' if value is more than 1
require msg colorcolorcolor of requirement messages

Short descriptions

external

typenamedescription
function (Boolean)NTS Is Talent Maxedchecks is given talent at its max level
function (Boolean)NTS Can Player Lean talentchecks if given player can learn given talent at that time (checking everything)
actionNTS Create Talent Tree (simple)Creates talent tree. Wrapped version with basic settings
actionNTS Create Talent Tree (advanced)Creates talent tree. Advanced version with all possible settings
actionNTS Create TalentCreates talent
actionNTS Create InitializeInitializes everything
function (integer)NTS Get Talent Current Levelreturns current level of given talent for given player
function (integer)NTS Get Talent Tree Total Levelsreturns amount of all levels in given tree for given player
function (dialog)NTS Get Tree Dialogreturns given tree dialog (for access reasons)
function (integer)NTS Get Available Talent Pointsreturns available talent points in given tree for given player
actionNTS Modify Talent Current Levelmodifies current level of given talent for given player
actionNTS Modify Available Talent Pointsmodifies current available points for given tree (applied for every tree in same share group)
actionNTS Show / Hide / Toggle Treechanges visibility of tree (dialog)
actionNTS Reset Talent Treeresets all levels of talents in given tree of given player to 0 and optionally sets available talent points amount to sum of those talents levels
function (string)NTS Save Tree To Stringsaves tree talents levels and available points into string format
actionNTS Load Tree From StringLoads tree talents levels and available points from string

Internal

typenamedescription
string_NTS_IDRandom id used for data table
string_NTS_FSField separator string used in syntax formatting
string_NTS_ISIndex separator string used in syntax formatting
string_NTS_CharsCharacters used from random ID
function (string)_ImageToStringGUI wrapper for conversion
function (file - image)_StringToImageGUI wrapper for conversion
function (preset - anchor)_IntToAnchorGUI wrapper for conversion
function (preset - blend mode)_IntToBlendModeGUI wrapper for conversion
function (game link - upgrade)_StringToUpgradeGUI wrapper for conversion
function (integer)_MinMaxIntwrapper for range integer
preset_NTSFields_BaseContains Base syntax fields ( main tables like)
preset_NTSFields_TalentContains Talent syntax fields
preset_NTSFields_TreeContains Tree syntax fields
preset_NTSFields_SettingsContains Settings syntax fields
function (string)_NTSBaseSyntaxreturns Base syntax string
function (string)_NTSTalentSyntaxreturns Talent syntax string
function (string)_NTSSettingsSyntaxreturns Settings syntax string
function (string)_NTSTreeSyntaxreturns Tree syntax string
action_NTSErrordisplays error in debug area
action_NTSAddButtonTCGUI wrapper, adds button to click event
function (integer)_NTSGetTreeNIndexreturns true tree index; for iteration
action_NTSRefreshRefresh tree dialog all buttons tooltips etc
function_NTSParseTooltipreturns parsed tooltip for talents
function (string)_NTSRequirmentMsgreturns 'Required' message.
event_NTSClickEventhandle clicks in trees
action_NTSClearTreeclears data table from not more needed tree fields
action_NTSClearTalentclears data table from not more needed talent fields
action_NTSClearLineclears data table from not more needed requirement arrow fields

Comments

Posts Quoted:
Reply
Clear All Quotes