[SCRIPT] Question about parameters

[Romulator]

Assuming the parameters are the Parent, Child and State, they are primarily used in the declaration to determine what collides with what.

Basically, they are there so that within this routine if you do need to reference them within the braces, you can call them from the void, and the void pulls them from the declaration. This can save you from typing in the object names from the Level Editor on multiple occasions if things only happen between these two objects. A good example is using alState in an if statement:

PHP Code: (Select All)

void func_shelf(string &in asEntity, int alState)
{
     if (alState == 1)           //Pull lever down all the way.
     {
     SetMoveObjectState("shelf",1.0f);           //Move shelf to reveal path
     PlaySoundAtEntity("", "quest_completed.snt", "shelf_move_1", 0, false);       //Play some catchy tunes
          return;
     }
} 


Another one could be something like using a key to open a door:

PHP Code: (Select All)

void OnStart()
{
    AddUseItemCallback("", "rusty_key", "locked_door_1", "OpenDoor", true);
}
 
void OpenDoor(string &in asItem, string &in asEntity)
{
    SetSwingDoorLocked(asEntity, false, true);          //locked_door_1 unlocks
    PlaySoundAtEntity("", "unlock_door", asEntity, 0, false);     //Play unlock sound at door
    RemoveItem(asItem);                     //Key comes out of inventory
} 


Bottom line is that if something happens to the declared Parent, Child, State, Effects etc, they can be referenced within the braces with ease