Files
MagicSetEditor2/doc/function/copy_file.txt
twanvl c212c56806 Yet more function documentation
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@573 0fc631ac-6414-0410-93d0-97cfa31319b6
2007-07-14 01:08:08 +00:00

23 lines
691 B
Plaintext

Function: copy_file
--Usage--
> copy_file(filename)
Copy a file from the export template package to the output directory.
If a file with the given name already exists it is overwritten.
Returns the name of the file written.
This function can only be used in an [[type:export template]], when <tt>create directory</tt> is true.
--Parameters--
! Parameter Type Description
| @input@ [[type:filename]] File to copy
--Examples--
> copy_file("logo.png") == "logo.png" # this file is now in the output directory
--See also--
| [[fun:write_text_file]] Write a text file to the output directory.
| [[fun:write_image_file]] Write an image file to the output directory.