Frozenbyte Wiki - User contributions [en]

Shadwen prefabs

2020-04-06T16:18:05Z

AlexanderJohr:

[[Shadwen Editor Tutorial|Shadwen Editor Tutorial Main Page]] 
[[Level art basics|-> Next tutorial (Level Art)]] 
[[shadwen_items|<- Previous tutorial (Items)]]

This section covers the basics of creating and using prefabs.

*'''Level path in Shadwen Public Editor''': '''''\data\mission\editor_tutorial\07_prefabs'''''

=Prefabs=

Prefabs are sets of types that help you make usable content more quickly.
Their contents can vary from just a floor and a wall to entire buildings.
They can easily be modified locally too if you want to make slight
alterations to the prefab without changing the original prefab itself.

You can find prefabs in '''Categories''' -> '''Category root''' -> '''block_sets'''.

===Parenting objects===
It's very common to combine art and collisions so that when collision is moved so will the art. Parenting pretty much means connecting one object to another. The one object that holds the other ones is the parent. If you move the parent, everything connected to it moves too.

===Master objects===
Master objects work pretty much the same way as parenting does. When you create a prefab you have to drag the prefab icon if you want to move the whole prefab and that can get inconvenient when the icon is inside the prefab. If you make a collision in the prefab a master object you can move it instead of the icon. This can make working easier and faster.
You can make your prefab's collision into a master object by right clicking the collision and choosing '''Prefab type - Set master object'''.

==Creating prefabs==

Here is the process of creating a simple prefab:

[[File:Tutorial_prefab_1v2.png|thumb|none|400px|Wall art and collision]]
The example will be a wall piece so a rockcollisionhelper and some wall art is needed.

[[File:Tutorial_prefab_2v2.png|thumb|none|400px|Art partially inside collision]]
The art should be set slightly inside the collision for the best possible effect.

===Parenting===
[[File:Tutorial_prefab_4v2.png|thumb|none|400px|Setting parent part 1]]
Next Parent the art into the collision. Right click on the art and choose '''set parent'''.

[[File:Tutorial_prefab_5v2.png|thumb|none|400px|Setting parent part 2]]
Choose the rockcollisionhelper and click ok.

[[File:Tutorial_prefab_3v2.png|thumb|none|400px|Final Step]]
Choose both objects and right-click them. Then choose '''Create
prefab from selection'''. Name your new prefab and you are done.

[[File:Tutorial_prefab_6v2.png|thumb|none|400px|In most cases big prefabs consists of multiple smaller ones]]
When a prefab consists of smaller prefabs the main icon will be the same color as always but the smaller ones will be green to make it easier to spot the main prefab.

[[File:Tutorial_prefab_7v2.png|thumb|none|400px|You can copy an old prefab to make a new one. Just ignore the prefab icon]]

You can create a new prefab using an old one by just choosing everything else than the prefab icon and click '''Create prefab from selection'''. After naming it you can modify it and save it without having to worry about it destroying the original prefab.

==Modification==

Modifying prefabs is pretty easy. If you make changes to a prefab the icon will change color until you either save those changes or undo them. Be careful about making changes though as there are two types of changes: Local and global ones. Global ones affect all prefabs of the same origin while locals only affect that one prefab you made the changes to. For example if you have a wall that consists of multiple
prefabs and you decide to change one in some way you should save it locally by right-clicking the prefab icon and choosing '''refab instance - Save all changes'''. This way the prefab you changed will be saved but the changes won't affect the other prefabs of the same name.

You can save all the local changes from all prefabs with the '''Check and save local changes to all prefabs''' button. You can find it next to the processing bubbles in editor. The icon is the same as the "save" one but it has a P on it. The icon next to this icon is '''Unparent all prefabs''' which can be used if you feel like you have no use for prefabs anymore.
[[File:Prefab_buttons.png|thumb|none|400px| Local saving and unparenting icons.]]

===Prefab icon colors===
The prefab icon has four different colors. White prefab icon is the default one that indicates that everything works like it should. When a bigger prefabs consists of multiple prefabs the prefabs inside the main prefab are green in color. If an object is moved in a green prefab it's icon color will turn yellow indivating that something has been changed but the change has not been saved. And lastly the red icon indicates that something in the white prefab has been changed and not saved.

[[File:Tutorial_prefab_8v2.png|thumb|none|400px|Red icon indicates made changes]]
If a prefab is changed in any way (an object is moved, removed etc) its icon will turn red to indicate that something has been changed. You can get rid of it by either undoing the changes or saving them. If you decide to save them, right-click on the prefab icon and choose '''Prefab type - Save all changes'''.

[[File:Tutorial_prefab_9v2.png|thumb|none|400px|Yellowish icon indicates change in an inner prefab]]
If the changes are made to a prefab inside a prefab the color of the small prefab will turn yellowish from its normal green color.

==Useful tips==
If you have accidentally moved parts of prefab in a way you don't like and haven't saved it yet you can reset the prefab. Right click on the prefab's icon and choose '''Prefab instance - Reset prefab'''.

If you delete a prefab from your map make sure to do it by deleting the prefab icon so that it deletes every object in the prefab.

=Creating new types=

If you make any changes to a type like coloring a wall a different color, you should make a new type so that if you use it in a prefab there won't be any unnecessary trash types. You can create a new type by right clicking the type you want to change in the type tree and clickin '''inherit new type''' . Check the components you want to use in the new type, click ok and then name your new type. After that you can make all the changes you want to it and the original type will remain the way it was.

If you are not sure if you have made changes to a type that you are going to use in a prefab you can always create a prefab with the '''Create prefab from selection (as original types)''' that is below '''Create prefab from selection''' to make sure you are making a prefab without trash types.

[[Shadwen Editor Tutorial|Shadwen Editor Tutorial Main Page]] 
[[Level art basics|-> Next tutorial (Level Art)]] 
[[shadwen_items|<- Previous tutorial (Items)]]

Shadwen rope targets

2020-04-06T14:50:59Z

AlexanderJohr: Typo: RopeTargetWoodCollisionHelperAimedopeTargetComponent ➡ RopeTargetWoodCollisionHelperAimedRopeTargetComponent

[[Shadwen Editor Tutorial|Shadwen Editor Tutorial Main Page]] 
[[Shadwen_ai|-> Next tutorial (AI)]] 
[[dynamic_objects|<- Previous tutorial (Dynamic Objects)]] 

This tutorial covers things related to Shadwen's rope item and teaches the basics of setting rope targets to your level in a correct way. While parts of this tutorial can also be used to help with the Trine editors, '''this tutorial page is heavily focused on Shadwen''', so not all of it will be helpful for those working with the Trine Editors.

=Rope Targets=
In Shadwen, if an object is made of wood, it's usually attachable by Shadwen's rope. In the editor, most of the wooden objects already function as rope targets by default. Below two components are needed to achieve this:
* '''AimedRopeTargetComponent'''
* '''BoxAreaComponent'''

[[File:ropetargetwood.png|thumb|right|400px|RopeTargetWoodCollisionHelper]]
{{StyledQuote|"'''RopeTargetWoodCollisionHelper''' is the easiest object to create rope targets with. 
This object can be found in the [[Type_tree|type tree]] under '''WoodCollisionHelper (ObjectEntity > object > Helper > CollisionHelper)'''. 
You can use these objects as they are straight from the get-go, no alterations are needed for them to function as rope targets."}}

The '''RopeTargetWoodCollisionHelper''' can be found in the type tree from: '''InstanceBase -> Entity ->ObjectEntity -> object -> Helper -> CollisionHelper -> WoodCollisionHelper'''
 

= Making Rope Targets=

===AimedRopeTargetComponent===
Inside the '''AimedRopeTargetComponent''' the first thing to look into is the '''Enabled property'''. This dictates whether or not the actual component is even used at all.

[[File:aimenabled.png|thumb|none|550px|Enabling the component is vital]]

===Target area===
[[File:aimedropetarget.png|thumb|right|500px|AimedRopeTargetComponent]]
{{StyledQuote|"Next up is choosing the area of the object which you can target with the rope. The properties that govern over this inside the component are '''WholePhysicsCanBeAttachPoint''' and '''AimTargetOffsets'''. 

'''WholePhysicsCanBeAttachPoint''' means that the entire physical area of the object acts as a target for your rope. No matter where you try to connect the rope, it will attach. 

'''AimTargetOffsets''' can be used to assign a certain point as the target for the rope. If you use this, you should see a small green wire sphere pop up in the middle of the object. This sphere marks the area which can be targeted with the rope. Then you can control where to place this sphere with the '''VC3 position''' under the AimTargetOffsets."}}

If you want only a certain part of an object to work as a rope target, you need to use '''AimTargetOffsets'''. To do this, press the [[file:plus.png|25px]] button next to the AimTargetOffsets. This will open up a sub section under the property. If you change the coordinates of the sub section you should see a small green sphere move around. This makes the area of the sphere to function as the target. You can assign multiple different spheres onto one object to act as targets. The default position of the sphere is (0,0,0) as in the center of the object. If you cannot aim into the area where the green sphere is you cannot use the rope on the object, so it is recommended to move the sphere(s) outside of the collisions of the object. If you are using multiple target points Shadwen will tie the rope to the nearest available spot. For example, if you want to use this method for a box, you will need the same amount of spheres as sides you want to be interacted with, ie. if all sides must be able to be roped you will need a minimum of 6 target points.
[[File:aimtargets.png|thumb|none|500px|The green sphere you see marks the area you can connect the rope to]]

Technically you can have both of these on at the same time, but the WholeAreaCanBeAttachPoint will override the AimTargetOffsets, so there isn't really any reason to use them both at the same time.

===Turning an object into a rope target===
[[File:treeaimedrope.png|thumb|right|400px|AimedRopeTargetComponent in the [[Type_tree|type tree]]]]
{{StyledQuote|"You can convert normal dynamic objects into rope targets by adding the '''AimedRopeTargetComponent''' and '''BoxAreaComponent''' into an object. Like any other component, you '''add them by selecting your object > Right click the object > Add component.''' 
The easiest way to find these components is to use the search function. They can also be found in the [[Type_tree|type tree]] from: '''ComponentBase > AbstractAreaComponent > AreaComponentBase > BoxAreaComponent and ComponentBase > AbstractGameplayComponent > AbstractTargetableComponent > AimedRopeTargetComponent.'''"}}

The '''AimedRopeTargetComponent''' requires the '''BoxAreaComponent''' to function properly.

* '''ComponentBase > AbstractGameplayComponent > AbstractTargetableComponent > AimedRopeTargetComponent''' holds all the different variations of the component. The main ones to look for are under '''RopeTargetWood''', but they are not the only ones you can us.
* '''ComponentBase > AbstractAreaComponent > AreaComponentBase > BoxAreaComponent'''

More information about adding components in the [[Dynamic_objects#Adding_Components|Dynamic Objects]] tutorial.

[[File:treeboxarea.png|thumb|left|400px|BoxAreaComponent in Type tree]]
[[File:boxarea.png|thumb|none|500px|BoxAreaComponent]]
<div style="clear:both;"></div> 
{{StyledQuote|"Some good components to use are '''AimedRopeTargetComponent(RopeTargetWoodCollisionHelperAimedRopeTargetComponent)''' and '''BoxAreaComponent(NinjaRopeTargetGameplayEntityBoxAreaComponent'''"}}

All the different components function pretty much the same way, they have just been customized to optimally work on certain objects. It is good to check how the AreaComponent works, as you might want to tweak it in order to make it function properly for different shaped objects.

[[Shadwen Editor Tutorial|Shadwen Editor Tutorial Main Page]] 
[[Shadwen_ai|-> Next tutorial (AI)]] 
[[dynamic_objects|<- Previous tutorial (Dynamic Objects)]]