Logic Component: Difference between revisions

From Pummel Party Mod Documentation
Jump to navigation Jump to search
(→‎Component Settings: Added round start/end triggers)
 
(5 intermediate revisions by 2 users not shown)
Line 2: Line 2:


== Component Settings ==
== Component Settings ==
[[File:LogicComponent.png|thumb|500px|The Logic Component in the [[Inspector Window]]. You can add multiple events to a single logic component.]]
{| class="wikitable"
{| class="wikitable"
|-
|-
! Property !! Description
! Property !! Description
|-
|-
|'''Event''' || The event to trigger a list of Actions on.
|'''Event''' || The event that triggers a list of Actions.
|-
| style="padding-left: 2em;" | ''None'' || Never triggered, why is this an option?
|-
|-
| style="padding-left: 2em;" | ''Start'' || Triggered at the start of a minigame, as the countdown begins.
| style="padding-left: 2em;" | ''Start'' || Triggered at the start of a minigame, as the countdown begins.
|-
|-
| style="padding-left: 2em;" | ''Enable'' || Triggered as soon as the minigame loads, while on the minigame load/intro screen.
| style="padding-left: 2em;" | ''Enable'' || Triggered each time this gameobject is enabled. This includes:
* being enabled automatically when the object is created as part of the scene as soon as the minigame loads (while still on the minigame load/intro screen)
* each time this gameobject is enabled by a [[Set Active Action]] if it was previously disabled.
|-
|-
| style="padding-left: 2em;" | ''Update'' || Triggered every frame. Not consistent between players due to varying framerates. '''For consistent timed actions use the ''Timer'' event instead.'''
| style="padding-left: 2em;" | ''Update'' || Triggered every frame. Not consistent between players due to varying framerates. '''For consistent timed actions use the ''Timer'' event instead.'''
Line 24: Line 25:
| style="padding-left: 2em;" | ''Timer'' || Triggered every x seconds.
| style="padding-left: 2em;" | ''Timer'' || Triggered every x seconds.
|-
|-
| style="padding-left: 4em;" | '''Interval Type''' || The type of interval for the timer.
| style="padding-left: 4em;" | '''Interval''' || The number of seconds between the event firing. Use the Arrow beside the ''Interval'' value to set the mode.
|-
|-
| style="padding-left: 2em;" | ''Constant'' || Actions are triggered repeatedly after a set number of seconds.
| style="padding-left: 6em;" | ''Constant'' || Actions are triggered repeatedly after a set number of seconds.
|-
|-
| style="padding-left: 2em;" | ''Random'' || Actions are triggered repeatedly after a random amount of time. The minimum and maximum amount of time between triggers can be set.
| style="padding-left: 6em;" | ''Random Between Two Values'' || Actions are triggered repeatedly after a random amount of time. The minimum and maximum amount of time between each firing of the event can be set.
|-
|-
| style="padding-left: 2em;" | ''Board Space'' || For [[Board Mod]]s. Triggered when this board space is landed on.
| style="padding-left: 2em;" | ''Round Start'' || Triggered at the start of each minigame round, after the round start countdown.
|-
| style="padding-left: 2em;" | ''Round End'' || Triggered at the end of each minigame round.
|-
|-
| '''Actions''' || The list of actions to run for the given Event.
| '''Actions''' || The list of actions to run for the given Event.
Line 39: Line 42:
''Start'' can be useful to make something happen when the minigame begins.
''Start'' can be useful to make something happen when the minigame begins.


''Timer'' with a random ''Interval Type'' can be used to add random effects to make the minigame more exciting.
''Timer'' with a random ''Interval'' can be used to add random effects to make the minigame more exciting. Use the arrow beside the value to change between constant and random values.
 
''Board Space'' is critical when making [[Custom Board Space|custom board spaces]]for board mods.


[[Category:Gameplay Components]]
[[Category:Gameplay Components]]
[[Category:Components]]
[[Category:Components]]

Latest revision as of 20:24, 17 December 2023

The logic component is a gameplay component that runs a series of actions for different events.

Component Settings

The Logic Component in the Inspector Window. You can add multiple events to a single logic component.
Property Description
Event The event that triggers a list of Actions.
Start Triggered at the start of a minigame, as the countdown begins.
Enable Triggered each time this gameobject is enabled. This includes:
  • being enabled automatically when the object is created as part of the scene as soon as the minigame loads (while still on the minigame load/intro screen)
  • each time this gameobject is enabled by a Set Active Action if it was previously disabled.
Update Triggered every frame. Not consistent between players due to varying framerates. For consistent timed actions use the Timer event instead.
Hit Triggered when the object this component is attached to is hit by the player or weapons.
Weapon Hit Triggered when the object this component is attached to is hit by a weapon.
Weapon Type The type(s) of weapon hit that will cause the actions to be triggered.
Timer Triggered every x seconds.
Interval The number of seconds between the event firing. Use the Arrow beside the Interval value to set the mode.
Constant Actions are triggered repeatedly after a set number of seconds.
Random Between Two Values Actions are triggered repeatedly after a random amount of time. The minimum and maximum amount of time between each firing of the event can be set.
Round Start Triggered at the start of each minigame round, after the round start countdown.
Round End Triggered at the end of each minigame round.
Actions The list of actions to run for the given Event.

Example Usage

Start can be useful to make something happen when the minigame begins.

Timer with a random Interval can be used to add random effects to make the minigame more exciting. Use the arrow beside the value to change between constant and random values.