Skip to content

6.3 Process Folders of Groups

Jump to bottom
Davide Magni edited this page Oct 24, 2016 · 4 revisions

Once your set of Folders is created, it's time to process multiple Groups with similar characteristics. Let's see how.

allow_group_folder

Change the allow status of all the Groups of a specific Folder. To be used in on note and on release only! If you need to set the allow state of a Folder from another callback, from a function etc., please check out the function group_folder_allow_state down below.

allow_group_folder(<folder_name>)

  • folder_name Name of the Folder to be allowed.

disallow_group_folder

Change the disallow status of all the Groups of a specific Folder. To be used in on note and on release only! If you need to set the allow state of a Folder from another callback, from a function etc., please check out the function group_folder_allow_state down below.

disallow_group_folder(<folder_name>)

  • folder_name Name of the Folder to be allowed.

purge_group_folder

Set the purge status of all the Groups of a specific Folder.

purge_group_folder(<folder_name>, <mode>)

  • folder_name Name of the Folder to be allowed.
  • mode Purge status. Can be either PURGED or NOT_PURGED.

engine_par_grp

Set an engine_par for all the Groups of a specific Folder.

An engine_par is every single parameter of any Effect or Modulator. Please refer to the specific section of KSP Reference Manual for more info.

engine_par_grp(<folder_name>, <engine_par>, <value>, <slot>)

  • folder_name Name of the Folder.
  • engine_par KSP pre-declared variable to set the target parameter. Please refer to the specific section of KSP Reference Manual for the complete list.
  • value Value of the parameter.
  • slot Slot of the Effect to be processed.

engine_par_all_grp

Set an engine_par for all the Groups.

An engine_par is every single parameter of any Effect or Modulator. Please refer to the specific section of KSP Reference Manual for more info.

engine_par_all_grp(<engine_par>, <value>, <slot>)

  • engine_par KSP pre-declared variable to set the target parameter. Please refer to the specific section of KSP Reference Manual for the complete list.
  • value Value of the parameter.
  • slot Slot of the Effect to be processed.

group_folder_allow_state

Set the allow state of a folder. This function requires the Event ID of the generated event, therefore it should be used after the note was generated. Unlike allow_group_folder and disallow_group_folder, this function can be used in any callback.

group_folder_allow_state(<folder_name>, <event_id>, <allow_state>)

  • folder_name Name of the Folder.
  • event_id Event ID of the generated note.
  • allow_state Set to YES to allow or to NO to disallow a Group Folder for the specific Event ID.
Clone this wiki locally