Header menu logo Nu

Behavior Module

Namespace: Nu.Behaviors
Assembly: Nu.dll

Behavior operators.

Functions and values

Function or value Description

``not`` bhvr

Full Usage: ``not`` bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline

A negation behavior.

bhvr : bool Behavior
Returns: bool Behavior

and_ b bhvr

Full Usage: and_ b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline

A logical and behavior.

b : bool
bhvr : bool Behavior
Returns: bool Behavior

append b bhvr

Full Usage: append b bhvr

Parameters:
Returns: ('b * 'a) Behavior

Append an element to construct a pair behavior.

b : 'a
bhvr : 'b Behavior
Returns: ('b * 'a) Behavior

apply bhvrF bhvrA

Full Usage: apply bhvrF bhvrA

Parameters:
Returns: 'b Behavior

Applicative apply.

bhvrF : ('a -> 'b) Behavior
bhvrA : 'a Behavior
Returns: 'b Behavior

bind bhvr f

Full Usage: bind bhvr f

Parameters:
Returns: 'b Behavior

Monadic bind.

bhvr : 'a Behavior
f : 'a -> 'b Behavior
Returns: 'b Behavior

constant k

Full Usage: constant k

Parameters:
    k : 'a

Returns: 'a Behavior

A behavior that emits a constant value 'k' at all times. The output behavior produces values of the same type as the provided constant value 'k'.

k : 'a
Returns: 'a Behavior

constantTween a arg2 bhvr

Full Usage: constantTween a arg2 bhvr

Parameters:
Returns: 'a Behavior
Modifiers: inline
Type parameters: 'a, 'b

A behavior that produces a value that remains constant (equal to 'a') regardless of the input behavior's value.

a : 'a
arg1 : 'a
bhvr : 'b Behavior
Returns: 'a Behavior

cosTween scale a b bhvr

Full Usage: cosTween scale a b bhvr

Parameters:
    scale : ^a * single -> ^a
    a : ^a
    b : ^a
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a cosine tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
a : ^a
b : ^a
bhvr : single Behavior
Returns: ^a Behavior

cosTweenScaled scale value value2 scalar bhvr

Full Usage: cosTweenScaled scale value value2 scalar bhvr

Parameters:
    scale : ^a * single -> ^a
    value : ^a
    value2 : ^a
    scalar : single
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a cosine tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
value : ^a
value2 : ^a
scalar : single
bhvr : single Behavior
Returns: ^a Behavior

cosTweenScaledf a b scalar bhvr

Full Usage: cosTweenScaledf a b scalar bhvr

Parameters:
    a : single
    b : single
    scalar : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a cosine tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
scalar : single
bhvr : single Behavior
Returns: single Behavior

cosTweenf a b bhvr

Full Usage: cosTweenf a b bhvr

Parameters:
    a : single
    b : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a cosine tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
bhvr : single Behavior
Returns: single Behavior

dec bhvr

Full Usage: dec bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

A decrement behavior.

bhvr : ^a Behavior
Returns: 'c Behavior

delta difference bhvr

Full Usage: delta difference bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

A behavior that subtracts a constant value.

difference : ^a
bhvr : ^b Behavior
Returns: 'c Behavior

dup bhvr

Full Usage: dup bhvr

Parameters:
Returns: ('a * 'a) Behavior

Duplicate a behavior.

bhvr : 'a Behavior
Returns: ('a * 'a) Behavior

ease scale a b bhvr

Full Usage: ease scale a b bhvr

Parameters:
    scale : ^a * single -> ^a
    a : ^a
    b : ^a
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
a : ^a
b : ^a
bhvr : single Behavior
Returns: ^a Behavior

easeIn scale a b bhvr

Full Usage: easeIn scale a b bhvr

Parameters:
    scale : ^a * single -> ^a
    a : ^a
    b : ^a
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and an "ease-in" effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
a : ^a
b : ^a
bhvr : single Behavior
Returns: ^a Behavior

easeInf a b bhvr

Full Usage: easeInf a b bhvr

Parameters:
    a : single
    b : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and an ease-in effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
bhvr : single Behavior
Returns: single Behavior

easeOut scale a b bhvr

Full Usage: easeOut scale a b bhvr

Parameters:
    scale : ^a * single -> ^a
    a : ^a
    b : ^a
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and an "ease-out" effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
a : ^a
b : ^a
bhvr : single Behavior
Returns: ^a Behavior

easeOutf a b bhvr

Full Usage: easeOutf a b bhvr

Parameters:
    a : single
    b : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and an ease-out effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
bhvr : single Behavior
Returns: single Behavior

easef a b bhvr

Full Usage: easef a b bhvr

Parameters:
    a : single
    b : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and an easing effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
bhvr : single Behavior
Returns: single Behavior

eq b bhvr

Full Usage: eq b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: 'a

A behavior that checks for equality with a value.

b : 'a
bhvr : 'a Behavior
Returns: bool Behavior

fst bhvr

Full Usage: fst bhvr

Parameters:
Returns: 'a Behavior

Map over the first element of a pair of behaviors.

bhvr : ('a * 'b) Behavior
Returns: 'a Behavior

id bhvr

Full Usage: id bhvr

Parameters:
    bhvr : 'a

Returns: 'a Behavior

The identity behavior.

bhvr : 'a
Returns: 'a Behavior

inc bhvr

Full Usage: inc bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

An increment behavior.

bhvr : ^a Behavior
Returns: 'c Behavior

isNegative bhvr

Full Usage: isNegative bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: ^a

A behavior that checks for non-positive values.

bhvr : ^a Behavior
Returns: bool Behavior

isPositive bhvr

Full Usage: isPositive bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: ^a

A behavior that checks for positive values.

bhvr : ^a Behavior
Returns: bool Behavior

isZero bhvr

Full Usage: isZero bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: ^a

An isZero behavior.

bhvr : ^a Behavior
Returns: bool Behavior

lerp a b bhvr

Full Usage: lerp a b bhvr

Parameters:
Returns: 'f Behavior
Modifiers: inline
Type parameters: ^a, ^b, ^c, ^d, ^e, 'f

A behavior that produces a value that is linearly interpolated between the values 'a' and 'b' based on the input behavior's value (interpreted as a normalized interpolation factor).

a : ^a
b : ^e
bhvr : ^c Behavior
Returns: 'f Behavior

lift1 op bhvr

Full Usage: lift1 op bhvr

Parameters:
Returns: 'b Behavior

Applicative lift 1.

op : 'a -> 'b
bhvr : 'a Behavior
Returns: 'b Behavior

lift2 op bhvr bhvr2

Full Usage: lift2 op bhvr bhvr2

Parameters:
Returns: 'c Behavior

Applicative lift 2.

op : 'a -> 'b -> 'c
bhvr : 'a Behavior
bhvr2 : 'b Behavior
Returns: 'c Behavior

lift3 op bhvr bhvr2 bhvr3

Full Usage: lift3 op bhvr bhvr2 bhvr3

Parameters:
Returns: 'd Behavior

Applicative lift 3.

op : 'a -> 'b -> 'c -> 'd
bhvr : 'a Behavior
bhvr2 : 'b Behavior
bhvr3 : 'c Behavior
Returns: 'd Behavior

lift4 op bhvr bhvr2 bhvr3 bhvr4

Full Usage: lift4 op bhvr bhvr2 bhvr3 bhvr4

Parameters:
Returns: 'e Behavior

Applicative lift 4.

op : 'a -> 'b -> 'c -> 'd -> 'e
bhvr : 'a Behavior
bhvr2 : 'b Behavior
bhvr3 : 'c Behavior
bhvr4 : 'd Behavior
Returns: 'e Behavior

lift5 op bhvr bhvr2 bhvr3 bhvr4 bhvr5

Full Usage: lift5 op bhvr bhvr2 bhvr3 bhvr4 bhvr5

Parameters:
Returns: 'f Behavior

Applicative lift 5.

op : 'a -> 'b -> 'c -> 'd -> 'e -> 'f
bhvr : 'a Behavior
bhvr2 : 'b Behavior
bhvr3 : 'c Behavior
bhvr4 : 'd Behavior
bhvr5 : 'e Behavior
Returns: 'f Behavior

loop stride bounce bhvr

Full Usage: loop stride bounce bhvr

Parameters:
    stride : ^a
    bounce : bool
    bhvr : ^b Behavior

Returns: ^c Behavior
Modifiers: inline
Type parameters: ^a, ^b, ^c, ^d

Loop over a behavior.

stride : ^a
bounce : bool
bhvr : ^b Behavior
Returns: ^c Behavior

map mapper bhvr

Full Usage: map mapper bhvr

Parameters:
Returns: 'b Behavior

Functor map.

mapper : 'a -> 'b
bhvr : 'a Behavior
Returns: 'b Behavior

map2 mapper bhvr bhvr2

Full Usage: map2 mapper bhvr bhvr2

Parameters:
Returns: 'c Behavior

Map over two behaviors.

mapper : 'a * 'b -> 'c
bhvr : 'a Behavior
bhvr2 : 'b Behavior
Returns: 'c Behavior

mapFst mapper bhvr

Full Usage: mapFst mapper bhvr

Parameters:
    mapper : 'a -> 'b
    bhvr : ('a * 'c) Behavior

Returns: ('b * 'c) Behavior

Map over the first element of a pair behavior.

mapper : 'a -> 'b
bhvr : ('a * 'c) Behavior
Returns: ('b * 'c) Behavior

mapProduct mapper bhvr

Full Usage: mapProduct mapper bhvr

Parameters:
    mapper : 'a -> 'b -> 'c
    bhvr : ('a * 'b) Behavior

Returns: 'c Behavior

Map over a pair of behaviors.

mapper : 'a -> 'b -> 'c
bhvr : ('a * 'b) Behavior
Returns: 'c Behavior

mapSnd mapper bhvr

Full Usage: mapSnd mapper bhvr

Parameters:
    mapper : 'a -> 'b
    bhvr : ('c * 'a) Behavior

Returns: ('c * 'b) Behavior

Map over the second element of a pair behavior.

mapper : 'a -> 'b
bhvr : ('c * 'a) Behavior
Returns: ('c * 'b) Behavior

max b bhvr

Full Usage: max b bhvr

Parameters:
Returns: 'a Behavior
Modifiers: inline
Type parameters: 'a

A max behavior.

b : 'a
bhvr : 'a Behavior
Returns: 'a Behavior

min b bhvr

Full Usage: min b bhvr

Parameters:
Returns: 'a Behavior
Modifiers: inline
Type parameters: 'a

A min behavior.

b : 'a
bhvr : 'a Behavior
Returns: 'a Behavior

modulo divisor bhvr

Full Usage: modulo divisor bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

A behavior that computes the remainder of a division by a constant value.

divisor : ^a
bhvr : ^b Behavior
Returns: 'c Behavior

nand b bhvr

Full Usage: nand b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline

A logical nand behavior.

b : bool
bhvr : bool Behavior
Returns: bool Behavior

negate bhvr

Full Usage: negate bhvr

Parameters:
Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A negation behavior.

bhvr : ^a Behavior
Returns: ^a Behavior

neq b bhvr

Full Usage: neq b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: 'a

A behavior that checks for inequality with a value.

b : 'a
bhvr : 'a Behavior
Returns: bool Behavior

nor b bhvr

Full Usage: nor b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline

A logical nor behavior.

b : bool
bhvr : bool Behavior
Returns: bool Behavior

normalize length bhvr

Full Usage: normalize length bhvr

Parameters:
Returns: float32 Behavior
Modifiers: inline

Normalize the execution of a behavior over the given length of time.

length : GameTime
bhvr : GameTime Behavior
Returns: float32 Behavior

notZero bhvr

Full Usage: notZero bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: ^a

A notZero behavior.

bhvr : ^a Behavior
Returns: bool Behavior

or_ b bhvr

Full Usage: or_ b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline

A logical or behavior.

b : bool
bhvr : bool Behavior
Returns: bool Behavior

pow2 n bhvr

Full Usage: pow2 n bhvr

Parameters:
Returns: Vector2 Behavior
Modifiers: inline

A behavior that raises to the given power (Vector2).

n : Vector2
bhvr : Vector2 Behavior
Returns: Vector2 Behavior

pow2i n bhvr

Full Usage: pow2i n bhvr

Parameters:
Returns: Vector2i Behavior
Modifiers: inline

A behavior that raises to the given power (Vector2i).

n : Vector2i
bhvr : Vector2i Behavior
Returns: Vector2i Behavior

pow3 n bhvr

Full Usage: pow3 n bhvr

Parameters:
Returns: Vector3 Behavior
Modifiers: inline

A behavior that raises to the given power (Vector3).

n : Vector3
bhvr : Vector3 Behavior
Returns: Vector3 Behavior

pow3i n bhvr

Full Usage: pow3i n bhvr

Parameters:
Returns: Vector3i Behavior
Modifiers: inline

A behavior that raises to the given power (Vector3i).

n : Vector3i
bhvr : Vector3i Behavior
Returns: Vector3i Behavior

pow4 n bhvr

Full Usage: pow4 n bhvr

Parameters:
Returns: Vector4 Behavior
Modifiers: inline

A behavior that raises to the given power (Vector4).

n : Vector4
bhvr : Vector4 Behavior
Returns: Vector4 Behavior

pow4i n bhvr

Full Usage: pow4i n bhvr

Parameters:
Returns: Vector4i Behavior
Modifiers: inline

A behavior that raises to the given power (Vector4i).

n : Vector4i
bhvr : Vector4i Behavior
Returns: Vector4i Behavior

powc n bhvr

Full Usage: powc n bhvr

Parameters:
Returns: Color Behavior
Modifiers: inline

A behavior that raises to the given power (Color).

n : Color
bhvr : Color Behavior
Returns: Color Behavior

powd n bhvr

Full Usage: powd n bhvr

Parameters:
Returns: float Behavior
Modifiers: inline

A behavior that raises to the given power (double).

n : float
bhvr : float Behavior
Returns: float Behavior

powf n bhvr

Full Usage: powf n bhvr

Parameters:
Returns: single Behavior
Modifiers: inline
Type parameters: ^a, ^b

A behavior that raises to the given power (single).

n : ^a
bhvr : ^b Behavior
Returns: single Behavior

pown n bhvr

Full Usage: pown n bhvr

Parameters:
Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that raises to the given power.

n : int
bhvr : ^a Behavior
Returns: ^a Behavior

prepend a bhvr

Full Usage: prepend a bhvr

Parameters:
Returns: ('a * 'b) Behavior

Prepend an element to construct a pair behavior.

a : 'a
bhvr : 'b Behavior
Returns: ('a * 'b) Behavior

product bhvr bhvr2

Full Usage: product bhvr bhvr2

Parameters:
Returns: ('a * 'b) Behavior

Map over two behaviors, producing a pair.

bhvr : 'a Behavior
bhvr2 : 'b Behavior
Returns: ('a * 'b) Behavior

pulse stride bhvr

Full Usage: pulse stride bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: ^a, ^b, ^c

A behavior that produces a boolean value indicating whether the input behavior's value corresponds to an odd step of the given constant value 'stride'.

stride : ^a
bhvr : ^b Behavior
Returns: bool Behavior

random bhvr

Full Usage: random bhvr

Parameters:
Returns: Random Behavior
Modifiers: inline
Type parameters: 'a

A random behavior.

bhvr : 'a Behavior
Returns: Random Behavior

randomb bhvr

Full Usage: randomb bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline
Type parameters: 'a

A random behavior (boolean).

bhvr : 'a Behavior
Returns: bool Behavior

randomd bhvr

Full Usage: randomd bhvr

Parameters:
Returns: float Behavior
Modifiers: inline
Type parameters: 'a

A random behavior (double).

bhvr : 'a Behavior
Returns: float Behavior

randomf bhvr

Full Usage: randomf bhvr

Parameters:
Returns: single Behavior
Modifiers: inline
Type parameters: 'a

A random behavior (single).

bhvr : 'a Behavior
Returns: single Behavior

randomi bhvr

Full Usage: randomi bhvr

Parameters:
Returns: int Behavior
Modifiers: inline
Type parameters: 'a

A random behavior (integer).

bhvr : 'a Behavior
Returns: int Behavior

randoml bhvr

Full Usage: randoml bhvr

Parameters:
Returns: int64 Behavior
Modifiers: inline
Type parameters: 'a

A random behavior (int64).

bhvr : 'a Behavior
Returns: int64 Behavior

ratio divisor bhvr

Full Usage: ratio divisor bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

A behavior that divides by a constant value.

divisor : ^a
bhvr : ^b Behavior
Returns: 'c Behavior

returnB a

Full Usage: returnB a

Parameters:
    a : 'a

Returns: 'a Behavior

Monadic return.

a : 'a
Returns: 'a Behavior

run a bhvr

Full Usage: run a bhvr

Parameters:
Returns: 'a

Run a behavior monad.

a : GameTime
bhvr : 'a Behavior
Returns: 'a

scale scalar bhvr

Full Usage: scale scalar bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

A behavior that multiplies by a constant value.

scalar : ^a
bhvr : ^b Behavior
Returns: 'c Behavior

sinTween scale a b bhvr

Full Usage: sinTween scale a b bhvr

Parameters:
    scale : ^a * single -> ^a
    a : ^a
    b : ^a
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a sinusoidal tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
a : ^a
b : ^a
bhvr : single Behavior
Returns: ^a Behavior

sinTweenScaled scale a b scalar bhvr

Full Usage: sinTweenScaled scale a b scalar bhvr

Parameters:
    scale : ^a * single -> ^a
    a : ^a
    b : ^a
    scalar : single
    bhvr : single Behavior

Returns: ^a Behavior
Modifiers: inline
Type parameters: ^a

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a sinusoidal tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

scale : ^a * single -> ^a
a : ^a
b : ^a
scalar : single
bhvr : single Behavior
Returns: ^a Behavior

sinTweenScaledf a b scalar bhvr

Full Usage: sinTweenScaledf a b scalar bhvr

Parameters:
    a : single
    b : single
    scalar : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a sinusoidal tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
scalar : single
bhvr : single Behavior
Returns: single Behavior

sinTweenf a b bhvr

Full Usage: sinTweenf a b bhvr

Parameters:
    a : single
    b : single
    bhvr : single Behavior

Returns: single Behavior
Modifiers: inline

A behavior that produces a value that is linearly interpolated between 'a' and 'b' using a custom scaling function and a sinusoidal tween effect based on the input behavior's value. The custom scaling function 'scale' should take a pair (difference, scalar) and return a value representing the interpolation factor. The output behavior produces values of the same type as 'a' and 'b'.

a : single
b : single
bhvr : single Behavior
Returns: single Behavior

slice start length bhvr

Full Usage: slice start length bhvr

Parameters:
    start : ^a
    length : ^c
    bhvr : ^b Behavior

Returns: ^c Behavior
Modifiers: inline
Type parameters: ^a, ^b, ^c

Slice a portion of behavior.

start : ^a
length : ^c
bhvr : ^b Behavior
Returns: ^c Behavior

snd bhvr

Full Usage: snd bhvr

Parameters:
Returns: 'b Behavior

Map over the second element of a pair of behaviors.

bhvr : ('a * 'b) Behavior
Returns: 'b Behavior

step stride bhvr

Full Usage: step stride bhvr

Parameters:
Returns: int Behavior
Modifiers: inline
Type parameters: ^a, ^b, ^c

A behavior that produces an integer value based on the input behavior's value divided by the given constant value 'stride'.

stride : ^a
bhvr : ^b Behavior
Returns: int Behavior

sum summand bhvr

Full Usage: sum summand bhvr

Parameters:
Returns: 'c Behavior
Modifiers: inline
Type parameters: ^a, ^b, 'c

A behavior that adds a constant value.

summand : ^a
bhvr : ^b Behavior
Returns: 'c Behavior

swap bhvr

Full Usage: swap bhvr

Parameters:
Returns: ('b * 'a) Behavior

Swap the elements of a pair behavior.

bhvr : ('a * 'b) Behavior
Returns: ('b * 'a) Behavior

time

Full Usage: time

Returns: GameTime Behavior

A behavior that emits the current 'GameTime' value at each time step.

Returns: GameTime Behavior

timeLoop stride bounce

Full Usage: timeLoop stride bounce

Parameters:
Returns: float32 Behavior

A normalized time-emitting loop behavior based on the specified 'stride' and 'bounce' parameters. The 'stride' parameter represents the duration of each loop iteration. The 'bounce' parameter indicates whether the loop will reverse its direction after each iteration. The output behavior produces normalized values (0.0f to 1.0f) indicating the progress within each loop iteration.

stride : GameTime
bounce : bool
Returns: float32 Behavior

timeLoopRaw stride bounce

Full Usage: timeLoopRaw stride bounce

Parameters:
Returns: GameTime Behavior

A time-emitting loop behavior based on the specified 'stride' and 'bounce' parameters. The 'stride' parameter represents the duration of each loop iteration. The 'bounce' parameter indicates whether the loop will reverse its direction after each iteration. The output behavior produces 'GameTime' values indicating the progress within each loop iteration.

stride : GameTime
bounce : bool
Returns: GameTime Behavior

timeSlice start length

Full Usage: timeSlice start length

Parameters:
Returns: float32 Behavior

A normalized time-slicing behavior that emits normalized values (0.0f to 1.0f) within the specified time range. The 'start' parameter represents the start time of the slice. The 'length' parameter indicates the duration of the time slice. The output behavior produces normalized values (0.0f to 1.0f) indicating the progress within the specified time range.

start : GameTime
length : GameTime
Returns: float32 Behavior

timeSliceRaw start length

Full Usage: timeSliceRaw start length

Parameters:
Returns: GameTime Behavior

A time-slicing behavior that emits 'GameTime' values within the specified time range. The 'start' parameter represents the start time of the slice. The 'length' parameter indicates the duration of the time slice. The output behavior produces 'GameTime' values within the specified time range.

start : GameTime
length : GameTime
Returns: GameTime Behavior

unit

Full Usage: unit

Returns: unit Behavior

Represents the do-nothing behavior, which does not emit any value over time.

Returns: unit Behavior

withFst a bhvr

Full Usage: withFst a bhvr

Parameters:
Returns: ('a * 'c) Behavior

Substitute the first element of a pair behavior.

a : 'a
bhvr : ('b * 'c) Behavior
Returns: ('a * 'c) Behavior

withSnd b bhvr

Full Usage: withSnd b bhvr

Parameters:
Returns: ('b * 'a) Behavior

Substitute the second element of a pair behavior.

b : 'a
bhvr : ('b * 'c) Behavior
Returns: ('b * 'a) Behavior

xor b bhvr

Full Usage: xor b bhvr

Parameters:
Returns: bool Behavior
Modifiers: inline

A logical xor behavior.

b : bool
bhvr : bool Behavior
Returns: bool Behavior

Type something to start searching.