KSP Plugin Framework - Plugin Examples and Structure v1.1 (Apr 6)

[TriggerAu]

https://ksppluginframework.codeplex.com/SourceControl/latest#Examples/PersistingData/DictionaryTest.cs

Have you verified that this code to store Dictionaries in ConfigNodeStorage still works recently? I'm trying to do *exactly* this, and while I get no errors on save or load, my .cfg file is empty (Just has the parent scope)

Been a long time since I looked at that code, but from recollection it was a test to see what would and wouldn't store, so I dont know if Dictionaries ever did store - same as how you still can't store/restore a Vector2 or Vector3d types directly. Last time I tried to store a Dictionary.

If you look here - https://github.com/TriggerAu/AlternateResourcePanel/blob/master/AlternateResourcePanel/Settings.cs#L116-134 you can see how I am using a dictionary in the ARP mod, but storing as a list - and using the ToDictionary() method to load the stored list into the dictionary thats used in the mod.

Hope that helps

[Agathorn]

Been a long time since I looked at that code, but from recollection it was a test to see what would and wouldn't store, so I dont know if Dictionaries ever did store - same as how you still can't store/restore a Vector2 or Vector3d types directly. Last time I tried to store a Dictionary.

If you look here - https://github.com/TriggerAu/AlternateResourcePanel/blob/master/AlternateResourcePanel/Settings.cs#L116-134 you can see how I am using a dictionary in the ARP mod, but storing as a list - and using the ToDictionary() method to load the stored list into the dictionary thats used in the mod.

Hope that helps

Ok so lists store ok? Wonder how that looks in the file. I could also pack a string, but I kind of want the file to be easily editable by people.

[TriggerAu]

Ok so lists store ok? Wonder how that looks in the file. I could also pack a string, but I kind of want the file to be easily editable by people.

If you are storing other objects then its pretty easy to read. KAC stores the alarms as a list in the save file, so it looks just like the vessel list in the save file too - using that confignodestorage class

[johnqevil]

Hey Trigger, is there a way to add a scrollview inside the dropdown menu? I have a list of 40 or so items I'd like to show up, but it gets cut off due to the size of the window.

[linuxgurugamer]

Trigger,

How would you suggest I change from the normal OnGUI system to using this framework?

[TriggerAu]

The simplest method would be to simply change your class to inherit from the MonoBehaviourExtended class instead of Monobehaviour and you can then use the OnGuiEvery and OnGuiOnce methods there to replicate the behaviour. That said if you are going to have a lot of windows it "may" be worth changing the way you do your windows to use the MonoBehaviourWindow as well. In KAC when I transitioned I used the first method for the existing windows and then all new stuff uses the MBW classes because there was soo much code to change.

Mind you when we go to Unity5 I have absolutely no idea what that will mean yet. So short answer is look at how much code you have, cheapest way will be MBE, longer model MBW, and I'd decide based on existing code and what functionality you are looking to use - ie if you want a bunch of the Window code, or to use the drop downs then add that to your consideration.

If you want to share which project you are thinking about I'm happy to have a browse of the source on GitHub, etc and see if I can give some specific advice

[linuxgurugamer]

The simplest method would be to simply change your class to inherit from the MonoBehaviourExtended class instead of Monobehaviour and you can then use the OnGuiEvery and OnGuiOnce methods there to replicate the behaviour. That said if you are going to have a lot of windows it "may" be worth changing the way you do your windows to use the MonoBehaviourWindow as well. In KAC when I transitioned I used the first method for the existing windows and then all new stuff uses the MBW classes because there was soo much code to change.

Mind you when we go to Unity5 I have absolutely no idea what that will mean yet. So short answer is look at how much code you have, cheapest way will be MBE, longer model MBW, and I'd decide based on existing code and what functionality you are looking to use - ie if you want a bunch of the Window code, or to use the drop downs then add that to your consideration.

If you want to share which project you are thinking about I'm happy to have a browse of the source on GitHub, etc and see if I can give some specific advice

For now, it's the CraftImport mod. It really only has two windows, one of which is reused for multiple windows depending on the situation.

Thanks

LGG

[linuxgurugamer]

The simplest method would be to simply change your class to inherit from the MonoBehaviourExtended class instead of Monobehaviour and you can then use the OnGuiEvery and OnGuiOnce methods there to replicate the behaviour. That said if you are going to have a lot of windows it "may" be worth changing the way you do your windows to use the MonoBehaviourWindow as well. In KAC when I transitioned I used the first method for the existing windows and then all new stuff uses the MBW classes because there was soo much code to change.

Mind you when we go to Unity5 I have absolutely no idea what that will mean yet. So short answer is look at how much code you have, cheapest way will be MBE, longer model MBW, and I'd decide based on existing code and what functionality you are looking to use - ie if you want a bunch of the Window code, or to use the drop downs then add that to your consideration.

If you want to share which project you are thinking about I'm happy to have a browse of the source on GitHub, etc and see if I can give some specific advice

So, the main class should inherit from MonoBehaviousExtended, and secondary classes should inherit the MonoBehaviourWindow?

Also, I'm going to be starting to write a new mod, and figure this would be a good way to learn this. So, all I'll need (for now) will be the ability to display a window using GUILayout stuff, and then I'll be registering a function to be called when a ship is launched.

Do you have a minimal sample with a window I can look at?

Thanks

[DMagic]

You can draw a UI using either MBE or MBW (MBW inherits from MBE).

The difference is that MBE should really on be used if you are using OnGUI directly.

Most KSP mods add their window to the KSP RenderManager, which handles things like hiding the window (so don't use it if you want, for example, to draw something on top of the R&D or Mission Control UI) and I think some drawing order functions. MBW uses the RenderManager and has some helper methods for drawing complex UIs, making sure everything is run in the correct order, tooltips, clamping the window to the screen edges, etc...

But only use MBW for a class that actually draws the window.

[TriggerAu]

If you are making a simple mod that only has a window you can quite simply have a single class that inherits from MBW

Theres a number of examples in the sourcecode repo here - https://github.com/TriggerAu/KSPPluginFramework/tree/master/Examples - including a very simple window one called MBWindow ironically

[linuxgurugamer]

how would you handle using toolbar buttons with this? Both the stock, and the Blizzy toolbar?

also, can you point me to some mods that are already using this?

Thanks


LGG

[Diazo]

It does not use this framework at all, but as an example of loading toolbar buttons, [url=https://github.com/SirDiazo/AGExt/blob/master/AGExt/Editor.cs#L418]I do so here.[/url]

The link goes to the IF statement where I decide whether to load my button into either Blizzy's or the stock toolbar, you should be able to backtrack my reference from there.

Let me know if you need more details.

D.

[linuxgurugamer]

[quote name='Diazo']It does not use this framework at all, but as an example of loading toolbar buttons, [URL="https://github.com/SirDiazo/AGExt/blob/master/AGExt/Editor.cs#L418"]I do so here.[/URL]

The link goes to the IF statement where I decide whether to load my button into either Blizzy's or the stock toolbar, you should be able to backtrack my reference from there.

Let me know if you need more details.

D.[/QUOTE]

Oh, i'm already loading buttons, was just wondering how it worked with the framework.


LGG

[DMagic]

I don't think the framework has anything specific about using stock or toolbar buttons. Pretty much all of TriggerAu's addons allow for both though; they are just something you have to add separately.

[linuxgurugamer]

Diazo,

Are you aware the forums are being updated and the blogs going away?

Seems a shame, but you should capture your blog somewhere else, if possible


LGG

[Azimech]

Too bad the links are broken.

[*Aqua*]

https://github.com/TriggerAu/KSPPluginFramework works perfectly.

[dboi88]

On 19/01/2014 at 3:29 AM, TriggerAu said:

Entries in this Series

 

• An Adventure in Plugin Coding
• An Adventure in Plugin Coding - 2. Building Blocks
• An Adventure in Plugin Coding - 3. A Fast Dev Environment... I hope
• An Adventure in Plugin Coding - 4. A Post with Class
• An Adventure in Plugin Coding - 5. A Window of Opportunity
• An Adventure in Plugin Coding - 6. Lay some skin on me
• An Adventure in Plugin Coding - 7. Thanks for the Persistence
• An Adventure in Plugin Coding - 8. Revisiting the Scene of the Crime

Hey,

@TriggerAu

Thanks for putting this together! Are these blog posts still available anywhere? the links don't work anymore.

Cheers

Edited June 30, 2016 by dboi88

[neitsa]

I couldn't find them either, even by using some google dorks, which means they have probably entirely disappeared from the forum.

I resorted using the wayback machine [ https://web.archive.org ]  (please note that all links below are external to this forum and go to web.archive.org) :

(Also note that you might have to click the "latest" button once on web archive)

• An Adventure in Plugin Coding
• An Adventure in Plugin Coding - 2. Building Blocks
• An Adventure in Plugin Coding - 3. A Fast Dev Environment... I hope
• An Adventure in Plugin Coding - 4. A Post with Class
• An Adventure in Plugin Coding - 5. A Window of Opportunity
• An Adventure in Plugin Coding - 6. Lay some skin on me
• An Adventure in Plugin Coding - 7. Thanks for the Persistence
• An Adventure in Plugin Coding - 8. Revisiting the Scene of the Crime

Edited June 30, 2016 by neitsa