Alpine Faction Event List: Difference between revisions

From Red Faction Wiki
No edit summary
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 44: Line 44:
<div class="column">
<div class="column">
{{Infobox RF1Event
{{Infobox RF1Event
|eventname      =  
|eventname      = Clone_Entity
|category      = AF_General
|category      = AF_General
|description    =  
|description    = Creates a clone of the linked entity with the same properties and settings as its source.
|on            =  
|on            = Create a clone at the event's position.
|params        = * ''':''' P
}}
{{Infobox RF1Event
|eventname      = Set_Player_World_Collide
|category      = AF_General
|description    = Control whether the player collides with level geometry.
|on            = Collision = true (default)
|off            = Collision = false
}}
{{Infobox RF1Event
|eventname      = Set_Level_Hardness
|category      = AF_General
|description    = Set the hardness for the loaded level (size of geo craters).
|on            = Set hardness to the specified value.
|params        = * '''hardness:''' (int, "Life") The hardness value to set.
}}
}}
</div><div class="column>
</div><div class="column>
{{Infobox RF1Event
{{Infobox RF1Event
|eventname      =  
|eventname      = HUD_Message
|category      = AF_General
|category      = AF_General
|description    =  
|description    = Display a green HUD message in the bottom middle of the screen (like the helper text when you pick up items).
|on            =  
|on            = Display the HUD message for the configured duration.
|params        = * '''message:''' (string, "Goal To Set") The message to display.
* '''duration:''' (int, hidden) Duration (in ms) the message will be displayed. If not specified, defaults to 5000 (5 seconds).
}}
{{Infobox RF1Event
|eventname      = Play_Video
|category      = AF_General
|description    = Play a .bik format video.
|on            = Play the video specified.
|params        = * '''filename:''' (string, "Goal To Set") The filename of the video to play.
}}
}}
</div><div style="clear: both;"></div>
</div><div style="clear: both;"></div>
==AF_Utility==
==AF_Utility==
<div class="column">
<div class="column">
{{Infobox RF1Event
{{Infobox RF1Event
|eventname      =  
|eventname      = SetVar
|category      = AF_Utility
|description    = Reconfigure a variable on linked events. Only supports new Alpine Faction events. Supports "delay" (float) as a variable name to set event delay. Other variable names are as indicated on this page. Specify the name of the variable to be set in the script name for SetVar using this scripe name format: "SetVar_VARNAME" where "VARNAME" is the variable name.
|on            = Set var_name to var_value on all linked events.
|params        = * '''var_name:''' (string, set via script name) The name of the variable to be set.
* '''var_value:''' (string, "Goal To Set") The value to set var_name to. You must ensure you are providing a valid value for the type of the variable you are setting. If not specified, defaults to a blank string.
}}
{{Infobox RF1Event
|eventname      = Remove_Link
|category      = AF_Utility
|category      = AF_Utility
|description    =  
|description    = Used to remove links. If "remove_all" is turned off (default), removes links between objects this event is linked to. If "remove_all" is turned on, remove all links between every object this event is linked to and any other objects.
|on            =  
|on            = Remove links.
|params        = * ''':''' P
|params        = * '''remove_all:''' (boolean, "Run") Turn on "remove_all".
}}
}}
</div><div class="column>
</div><div class="column>
{{Infobox RF1Event
{{Infobox RF1Event
|eventname      =  
|eventname      = Clear_Queued
|category      = AF_Utility
|description    = Clears queued message (if any) on all linked events. Queued messages are messages that are queued per a configured delay value on that event.
|on            = Clear queued messages.
}}
{{Infobox RF1Event
|eventname      = Add_Link
|category      = AF_Utility
|category      = AF_Utility
|description    =  
|description    = Adds links from the first link in the link array to each other link in the array. Link array is ordered based on the order in which you linked this event to other objects.
|on            =  
|on            = Add links.
}}
}}
</div><div style="clear: both;"></div>
</div><div style="clear: both;"></div>

Latest revision as of 00:15, 25 November 2024



    • This page lists all new event scripting objects available in Alpine Faction.

    AF_Flow

    Icon Event E.png

    Sequence

    Each activation of this event routes the message to the next link in sequential order. After the last link, the cycle resets and the first link is called. Note the order of links is determined by the order in which you add them.
    On Response
    Send an on signal to the next link in the sequence.
    Off Response
    None
    Parameters
    • last_link_index: (int, hidden) Stores the last activated link index. When processing a received on signal, the next index in the links array after this is used.
    Icon Event E.png

    Difficulty_Gate

    Tests if the game is set to the specified difficulty and forwards messages only if true.
    On Response
    Forward on signal to all links, if the game is set to the specified difficulty.
    Off Response
    None
    Parameters
    • difficulty: (int, "Life") Set the difficulty to test against. 0 = easy, 1 = medium, 2 = hard, 3 = impossible
    Icon Event E.png

    Valid_Gate

    Tests if the specified UID is a valid object and forwards messages only if true. In the case of objects that have life values (ie. clutter and entities), "valid" means alive.
    On Response
    Forward on signal to all links, if the specified object is valid.
    Off Response
    None
    Parameters
    • check_uid: (int, "Life") Object UID to be checked.
    Icon Event E.png

    Switch_Random

    Randomly select one of this event's links and send an on signal to it.
    On Response
    Send an on signal to a randomly selected link.
    Off Response
    None
    Parameters
    No additional parameters.
    Icon Event E.png

    Fixed_Delay

    Identical to the normal Delay event, but cannot be retriggered. Will forward a message to all links after the specified delay. Messages sent to this event while a message is queued are ignored.
    On Response
    Queue a message to be forwarded after the configured delay.
    Off Response
    None
    Parameters
    No additional parameters.

    AF_General

    Icon Event E.png

    Clone_Entity

    Creates a clone of the linked entity with the same properties and settings as its source.
    On Response
    Create a clone at the event's position.
    Off Response
    None
    Parameters
    No additional parameters.
    Icon Event E.png

    Set_Player_World_Collide

    Control whether the player collides with level geometry.
    On Response
    Collision = true (default)
    Off Response
    Collision = false
    Parameters
    No additional parameters.
    Icon Event E.png

    Set_Level_Hardness

    Set the hardness for the loaded level (size of geo craters).
    On Response
    Set hardness to the specified value.
    Off Response
    None
    Parameters
    • hardness: (int, "Life") The hardness value to set.
    Icon Event E.png

    HUD_Message

    Display a green HUD message in the bottom middle of the screen (like the helper text when you pick up items).
    On Response
    Display the HUD message for the configured duration.
    Off Response
    None
    Parameters
    • message: (string, "Goal To Set") The message to display.
    • duration: (int, hidden) Duration (in ms) the message will be displayed. If not specified, defaults to 5000 (5 seconds).
    Icon Event E.png

    Play_Video

    Play a .bik format video.
    On Response
    Play the video specified.
    Off Response
    None
    Parameters
    • filename: (string, "Goal To Set") The filename of the video to play.

    AF_Utility

    Icon Event E.png

    SetVar

    Reconfigure a variable on linked events. Only supports new Alpine Faction events. Supports "delay" (float) as a variable name to set event delay. Other variable names are as indicated on this page. Specify the name of the variable to be set in the script name for SetVar using this scripe name format: "SetVar_VARNAME" where "VARNAME" is the variable name.
    On Response
    Set var_name to var_value on all linked events.
    Off Response
    None
    Parameters
    • var_name: (string, set via script name) The name of the variable to be set.
    • var_value: (string, "Goal To Set") The value to set var_name to. You must ensure you are providing a valid value for the type of the variable you are setting. If not specified, defaults to a blank string.
    Icon Event E.png

    Remove_Link

    Used to remove links. If "remove_all" is turned off (default), removes links between objects this event is linked to. If "remove_all" is turned on, remove all links between every object this event is linked to and any other objects.
    On Response
    Remove links.
    Off Response
    None
    Parameters
    • remove_all: (boolean, "Run") Turn on "remove_all".
    Icon Event E.png

    Clear_Queued

    Clears queued message (if any) on all linked events. Queued messages are messages that are queued per a configured delay value on that event.
    On Response
    Clear queued messages.
    Off Response
    None
    Parameters
    No additional parameters.
    Icon Event E.png

    Add_Link

    Adds links from the first link in the link array to each other link in the array. Link array is ordered based on the order in which you linked this event to other objects.
    On Response
    Add links.
    Off Response
    None
    Parameters
    No additional parameters.
    Retrieved from "https://www.redfactionwiki.com/w/index.php?title=Alpine_Faction_Event_List&oldid=14585"