Skip to content

Global Functions

Kakrain edited this page Jun 27, 2026 · 3 revisions

Global Functions (@)

Function Description
@Print(variable:any) This prints the variable in the log, whatever kind of variable it is
@InspectRecord(A:record group,string_id:string) This function inspects a specific record found in a specific group record, all of its fields in the current state given the load order.
@InspectField(A:record group,field:string) This function inspects a specific field of every record in a specific group record.
@ShowRecordEvolution(string_id:string) This function requires a string_id and shows which mods defined or modified it in the load order and in which order.
@Stop() Stops the current patch.
@AskConfig(variable:any,question:string) Prepares the specific variable to be asked later with a particular question
@ShowConfig() Shows the configuration window with all prepared variables.
@ApplyCurrentPatch(A:record group) Normally the patcher assumes the current state of the records to be all the load order but without the patch applied, this applies this specific patch to this group_record, so subsequent operations will take it into account.
@PropagateExtraDataByField(A:record group ,field:string ,category:string, optional values:array) accross every record in group_record, use the value of a specific string and distribute all ExtraData in a specific category, so every record which hold a specific value, will have all ExtraData records of other records which have the same value in that field.
@ExpandExtraDataByField(A:record  ,field:string ,category:string, optional values:array) accross every record in group_record, use the value of a specific string and distribute all ExtraData in a specific category, so every record which hold a specific value, will have all ExtraData records of other records which have the same value in that field, additionally, if records who have different values in that field, have a common ExtraData; their ExtraData will also be shared
@SkipLinesIf(condition:bool,n:int) if the boolean variable is true, skip the following n lines of the patch
@RunLinesIf(condition:bool,n:int) if the boolean variable is true, runs the following n lines of the patch

Clone this wiki locally