GetCmdHelp.eyeonscript

From VFXPedia

Jump to: navigation, search
This script connects to Fusion and displays help on eyeonscript objects and methods in your command line..

Example usage:


Image:GetCmdHelp.jpg


The script: (copy/paste):

--
--      GetCmdHelp.eyeonscript, rev.2
--
--	written Aug 10,2006 by peter@wwfx.net
--
--	Prints  help on eyeonscript objects functions and methods in command line. Example above shows usage inside Scite.
--
--		Install:
--
--	1) Place the script somewhere on your computer.
--	2) Put in your SciTEUser.properties file line like this:
--
-- 	command.help.$(file.patterns.eyeonscript)="D:\Program Files\Rotation\eyeonScript.exe" -q  "D:\Program Files\SciTe\tools\getcmdhelp.eyeonscript"  $(CurrentWord)
 
--      3) update paths to eyeonscript.exe and GetCmdHelp.eyeonscript  accordingly.
--
--
 
if not  (arg[1]) then
	print('To get help, please select or place cursor on some word and press F1 ')
	do return end
end
 
if not fusion  then  fusion=Fusion('localhost') end
 
if (fusion == nil) then
		print('\nUnable to connect to Fusion.\nPlease start Fusion so we can get help on "'..arg[1]..'"\n\n')
		do return end
end
 
help = fusion:GetHelp(arg[1])
 
if  help then
			print(help)
else
			print('No help available on:  ' .. arg[1])
end