Readme.md

SkookumScript Helpers

This is a repository of various helpers that I've written for various SkookumScript projects. Many of these are simple wrappers whose only achievement is providing sane defaults so that you don't need to pass in a ton of arguments to common functions. Others add functionality that is missing in Unreal Engine 4.

How to Install

• Clone or download this repo somewhere.
• In your project folder edit Scripts/Skookum-project.ini and add the path to the repo as an overlay, make sure you adjust overlay numbers appropriately. If you'd like to make changes to the code in this overlay then place it prior to your project overlay like I've done in the example below, otherwise you can put it last.

Overlay1=*Core|Core
Overlay2=-*Core-Sandbox|Core-Sandbox
Overlay3=*VectorMath|VectorMath
Overlay4=*Engine-Generated|Engine-Generated|A
Overlay5=*Engine|Engine
Overlay6=SkHelpers|C:\GitHub\SkHelpers
Overlay7=*Project-Generated-BP|Project-Generated-BP|C
Overlay8=*Project-Generated-C++|Project-Generated-C++|A
Overlay9=Project|Project

What's Included

(Alphabetical by class)

Actor

• destroy_sk_actor
• furthest_in_dir

AnimInstance

• _wait_anim_state

Boolean

• as_ints
• as_objs
• as_reals
• as_vec3s
• _wait_cycle_return_value
• _wait_false_true
• _wait_true_false

CameraComponent

• aspect_ratio_constrained?

Color

• near?

Controller

• _wait_pawn_null
• _wait_pawn_valid

GameLib

• deproject_nscreen_to_world
• deproject_point_to_plane
• viewport_coordinates_norm_to_screen
• viewport_coordinates_screen_to_norm
• viewport_size

HitResult

• !fake

Integer

• even?
• odd?

LevelSequenceActor

• jump_to_end

Object

• _wait_frames

PlayerController

• active_camera

Random

• vector3_between

SoundCue

• _play
• play

SystemLib

• print_log
• print_screen

Transform

• near?

Vector3

• !one

World

• _time_dilation_ramp

Hierarchical

• Object
  • _wait_frames
  • Boolean
    • as_ints
    • as_objs
    • as_reals
    • as_vec3s
    • _wait_cycle_return_value
    • _wait_false_true
    • _wait_true_false
  • Color
    • near?
  • Entity
    • Actor
      • destroy_sk_actor
      • furthest_in_dir
      • Controller
        • _wait_pawn_null
        • _wait_pawn_valid
        • PlayerController
          • active_camera
      • LevelSequenceActor
        • jump_to_end
    • ActorComponent
      • SceneComponent
        • CameraComponent
          • aspect_ratio_constrained?
    • AnimInstance
      • _wait_anim_state
    • BlueprintFunctionLibrary
      • GameLib
        • deproject_nscreen_to_world
        • deproject_point_to_plane
        • viewport_coordinates_norm_to_screen
        • viewport_coordinates_screen_to_norm
        • viewport_size
      • SystemLib
        • print_log
        • print_screen
    • SoundBase
      • SoundCue
        • _play
        • play
    • World
      • _time_dilation_ramp
  • Integer
    • even?
    • odd?
  • Random
    • vector3_between
  • UStruct
    • HitResult
      • !fake
  • Transform
    • near?
  • Vector3
    • !one