Enfusion Script API
Loading...
Searching...
No Matches
Public Member Functions | List of all members
WeatherStateTransitionNode Interface Reference

Public Member Functions

proto external void SetLooping (bool looping)
 
proto external bool IsLooping ()
 
proto external void SetTransitionDurationHours (float transDurationHours)
 Sets transition duration in in-game hours.
 
proto external void SetStateDurationHours (float stateDurationHours)
 Sets destination state duration in in-game hours.
 
proto external int GetDestinationStateIndex ()
 Gets destination state index.
 
proto external float GetTransitionDurationHours ()
 Gets transition duration in in-game hours.
 
proto external float GetStateDurationHours ()
 Gets destination state duration in in-game hours.
 
proto external bool IsValid ()
 Checks whether this state transition node points to a valid destination state.
 
proto external bool IsValidTransitionTo (WeatherStateTransitionNode destinationState)
 Checks whether a transition can be done between this node and the one.
 
proto external bool IsTransitioning ()
 Checks whether this node is transitioning.
 

Member Function Documentation

◆ GetDestinationStateIndex()

proto external int WeatherStateTransitionNode.GetDestinationStateIndex ( )

Gets destination state index.

◆ GetStateDurationHours()

proto external float WeatherStateTransitionNode.GetStateDurationHours ( )

Gets destination state duration in in-game hours.

◆ GetTransitionDurationHours()

proto external float WeatherStateTransitionNode.GetTransitionDurationHours ( )

Gets transition duration in in-game hours.

◆ IsLooping()

proto external bool WeatherStateTransitionNode.IsLooping ( )

◆ IsTransitioning()

proto external bool WeatherStateTransitionNode.IsTransitioning ( )

Checks whether this node is transitioning.

Returns
True if transitioning, false if not transitioned yet or if transitioned completely

◆ IsValid()

proto external bool WeatherStateTransitionNode.IsValid ( )

Checks whether this state transition node points to a valid destination state.

Invalid state transition nodes cannot be enqueued or triggered to transition.

Returns
True if valid, False if state transition is pointing to an invalid (not found) destination state.

◆ IsValidTransitionTo()

proto external bool WeatherStateTransitionNode.IsValidTransitionTo ( WeatherStateTransitionNode  destinationState)

Checks whether a transition can be done between this node and the one.

Parameters
destinationStateDestination state after the current one.
Returns
true if compatibel, false otherwise.

◆ SetLooping()

proto external void WeatherStateTransitionNode.SetLooping ( bool  looping)

◆ SetStateDurationHours()

proto external void WeatherStateTransitionNode.SetStateDurationHours ( float  stateDurationHours)

Sets destination state duration in in-game hours.

◆ SetTransitionDurationHours()

proto external void WeatherStateTransitionNode.SetTransitionDurationHours ( float  transDurationHours)

Sets transition duration in in-game hours.


The documentation for this interface was generated from the following file: