unreal.BlendSpacePlayerLibrary
¶
- class unreal.BlendSpacePlayerLibrary(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
BlueprintFunctionLibrary
Exposes operations to be performed on a blend space player anim node.
C++ Source:
Module: AnimGraphRuntime
File: BlendSpacePlayerLibrary.h
- classmethod convert_to_blend_space_player(node) -> (BlendSpacePlayerReference, result=AnimNodeReferenceConversionResult)¶
Get a blend space player context from an anim node context.
- Parameters:
node (AnimNodeReference) –
- Returns:
result (AnimNodeReferenceConversionResult):
- Return type:
- classmethod convert_to_blend_space_player_pure(node) -> (blend_space_player=BlendSpacePlayerReference, result=bool)¶
Get a blend space player context from an anim node context (pure).
- Parameters:
node (AnimNodeReference) –
- Returns:
blend_space_player (BlendSpacePlayerReference):
result (bool):
- Return type:
tuple
- classmethod get_blend_space(blend_space_player) BlendSpace ¶
Get the current BlendSpace of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
- Return type:
- classmethod get_loop(blend_space_player) bool ¶
Get the current loop of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
- Return type:
- classmethod get_play_rate(blend_space_player) float ¶
Get the current play rate of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
- Return type:
- classmethod get_position(blend_space_player) Vector ¶
Get the current position of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
- Return type:
- classmethod get_start_position(blend_space_player) float ¶
Get the current start position of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
- Return type:
- classmethod set_blend_space(blend_space_player, blend_space) BlendSpacePlayerReference ¶
Set the current BlendSpace of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
blend_space (BlendSpace) –
- Return type:
- classmethod set_blend_space_with_inertial_blending(update_context, blend_space_player, blend_space, blend_time=0.200000) BlendSpacePlayerReference ¶
Set the current BlendSpace of the blend space player with an interial blend time.
- Parameters:
update_context (AnimUpdateContext) –
blend_space_player (BlendSpacePlayerReference) –
blend_space (BlendSpace) –
blend_time (float) –
- Return type:
- classmethod set_loop(blend_space_player, loop) BlendSpacePlayerReference ¶
Set the loop of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
loop (bool) –
- Return type:
- classmethod set_play_rate(blend_space_player, play_rate) BlendSpacePlayerReference ¶
Set the play rate of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
play_rate (float) –
- Return type:
- classmethod set_reset_play_time_when_blend_space_changes(blend_space_player, reset) BlendSpacePlayerReference ¶
Set whether the current play time should reset when BlendSpace changes of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
reset (bool) –
- Return type:
- classmethod should_reset_play_time_when_blend_space_changes(blend_space_player) bool ¶
Get the current value of whether the current play time should reset when BlendSpace changes of the blend space player.
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
- Return type:
- classmethod snap_to_position(blend_space_player, new_position) None ¶
Forces the Position to the specified value
- Parameters:
blend_space_player (BlendSpacePlayerReference) –
new_position (Vector) –