Mercurial > vim-unreal

comparison doc/unreal.txt @ 5:0afb2c0a6477

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add help info on statuslines.
author Ludovic Chabant <ludovic@chabant.com>
date Fri, 22 Jan 2021 16:52:30 -0800
parents 86156dffebe8
children
comparison
equal deleted inserted replaced
4:86156dffebe8 5:0afb2c0a6477
25 somewhere inside your codebase, and it should "just work". You'll be able to 25 somewhere inside your codebase, and it should "just work". You'll be able to
26 run commands such as |UnrealGenerateProjectFiles| and |UnrealBuild|. It is 26 run commands such as |UnrealGenerateProjectFiles| and |UnrealBuild|. It is
27 recommended to install vim-dispatch for running these operations in the 27 recommended to install vim-dispatch for running these operations in the
28 background. 28 background.
29 29
30 If you install the vim-crosoft plugin, vim-unreal will also automatically set 30 If you have vim-crosoft installed, vim-unreal will also automatically set the
31 the root Visual Studio solution as the active solution. This will bring 31 root Visual Studio solution as the active solution. This will bring better
32 better file-listing support for file-listers supported by vim-crosoft (FZF is 32 file-listing support for file-listers supported by vim-crosoft (FZF is
33 recommended), clangd language server support (YouCompleteMe is recommended), 33 recommended), clangd language server support (YouCompleteMe is recommended),
34 and so on. For supporting other infrastructures, refer to the vim-crosoft 34 and so on. For supporting other infrastructures, refer to the vim-crosoft
35 plugin or other appropriate plugin. 35 plugin or other appropriate plugin.
36
37 It is recommended that you add |unreal#statusline()| to your 'statusline'
38 manager or configuration. For example, if you use vim-lightline, you would do:
39
40 :let g:lightline['component_function']['unreal'] = 'unreal#statusline'
41 :call add(g:lightline['active']['right'], ['unreal'])
36 42
37 ============================================================================== 43 ==============================================================================
38 *unreal-configuration* 44 *unreal-configuration*
39 Configuration 45 Configuration
40 46
65 on startup and find an appropriate project to set. 71 on startup and find an appropriate project to set.
66 Vim-unreal saves the last set project of each known branch 72 Vim-unreal saves the last set project of each known branch
67 so that after restarting Vim it can restore the same project 73 so that after restarting Vim it can restore the same project
68 as last time. 74 as last time.
69 Default: `0` 75 Default: `0`
70 76
71 *g:unreal_auto_build_modules* 77 *g:unreal_auto_build_modules*
72 g:unreal_auto_build_modules 78 g:unreal_auto_build_modules
73 Dictionary of Unreal modules to always automatically build 79 Dictionary of Unreal modules to always automatically build
74 along with the current project's main module when running 80 along with the current project's main module when running
75 the |UnrealBuild| command and associated commands. 81 the |UnrealBuild| command and associated commands.
188 Reloads the branch's projects. This is only needed if the 194 Reloads the branch's projects. This is only needed if the
189 codebase was updated without restarting Vim and vim-unreal's 195 codebase was updated without restarting Vim and vim-unreal's
190 knowledge of the projects was outdated. 196 knowledge of the projects was outdated.
191 197
192 ============================================================================== 198 ==============================================================================
199 *unreal-functions*
200 Functions
201
202 *unreal#statusline*
203 unreal#statusline
204 Returns a string appropriate for showing in your
205 'statusline'. The string is empty if vim-unreal hasn't
206 detected any Unreal Engine codebase. Otherwise, it shows
207 a variety of relevant information such as the branch root
208 directory, and the currently set project and configuration.
209
210 ==============================================================================
193 *unreal-internals* 211 *unreal-internals*
194 Internals 212 Internals
195 213
196 *g:unreal_branch_projects* 214 *g:unreal_branch_projects*
197 g:unreal_branch_projects 215 g:unreal_branch_projects
224 g:unreal_config_target 242 g:unreal_config_target
225 The currently set Unreal configuration target. 243 The currently set Unreal configuration target.
226 It can be set with the |UnrealSetConfig| command. 244 It can be set with the |UnrealSetConfig| command.
227 245
228 246
229 " vim:tw=78:et:ft=help:norl: 247 " vim:tw=78:sw=3:ts=3:et:ft=help:norl: