Difference between revisions of "AlignChar (CMS)"

From The Official Visionaire Studio: Adventure Game Engine Wiki
m
 
(4 intermediate revisions by the same user not shown)
Line 7: Line 7:
  
 
This small function allows you to quickly align a character to another character.
 
This small function allows you to quickly align a character to another character.
 +
<hr>
 
{| class="toccolours mw-collapsible mw-collapsed ts"
 
{| class="toccolours mw-collapsible mw-collapsed ts"
 
|-
 
|-
Line 15: Line 16:
 
| There is no simple method for obtaining the top (y) pixel coordinate of the currently active character animation.
 
| There is no simple method for obtaining the top (y) pixel coordinate of the currently active character animation.
 
|}
 
|}
 +
  
 
== Instructions ==
 
== Instructions ==
Line 30: Line 32:
 
alignChar("Tom")
 
alignChar("Tom")
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
== Main Script ==
 
== Main Script ==
 
<syntaxhighlight lang="lua">
 
<syntaxhighlight lang="lua">
 
function alignChar(c, t)
 
function alignChar(c, t)
  if c == nil then c = game.CurrentCharacter else c = Characters[c] end -- check if character or current character
+
  if c == nil then c = game.CurrentCharacter else c = Characters[c] end -- store character or current character
  if t == nil then t = game.CurrentCharacter else t = Characters[t] end -- check if character or current character
+
  if t == nil then t = game.CurrentCharacter else t = Characters[t] end -- store character or current character
 
  -- + --
 
  -- + --
 
  local p1 = c.Position -- store characters position
 
  local p1 = c.Position -- store characters position
Line 50: Line 53:
 
end
 
end
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
== Syntax Breakdown ==
 
== Syntax Breakdown ==
Line 58: Line 62:
 
| c || "string" or nil || This should be a "string" value containing the name of the character you want to affect, or nil if you want to link to the current character.
 
| c || "string" or nil || This should be a "string" value containing the name of the character you want to affect, or nil if you want to link to the current character.
 
|-
 
|-
| t || "string" || This should be a "string" value containing the name of the character you want to align to, or nil if you want to link to the current character.
+
| t || "string" or nil || This should be a "string" value containing the name of the character you want to align to, or nil if you want to link to the current character.
 
|}{{toc}}
 
|}{{toc}}

Latest revision as of 19:49, 23 August 2022

Name Type By
alignChar("c", "t") Definition AFRLme

This small function allows you to quickly align a character to another character.


Additional Info
Alignment is based on character center which is usually set near the feet.
There is no simple method for obtaining the top (y) pixel coordinate of the currently active character animation.


Instructions

1. Add the main script to the Visionaire Studio Script Editor & set the script as a definition script.
2a. To align current character to another character...

alignChar(nil, "Tom")

2b. To align a specific character to another character...

alignChar("Tom", "Barry")

2c. To align a specific character to current character...

alignChar("Tom")


Main Script

function alignChar(c, t)
 if c == nil then c = game.CurrentCharacter else c = Characters[c] end -- store character or current character
 if t == nil then t = game.CurrentCharacter else t = Characters[t] end -- store character or current character
 -- + --
 local p1 = c.Position -- store characters position
 local p2 = t.Position -- store target characters position
 -- + --
 local ax, ay
 ax = p2.x - p1.x -- calculate x destination coordinate
 ay = p1.y - p2.y -- calculate y destination coordinate
 -- + --
 local angle = math.deg( math.atan(ay, ax) ) -- calculate angle
 if angle < 0 then angle = 360 + angle end -- some fallback? I don't remember why I wrote it
 -- + -- 
 c.Direction = angle -- update specified characters direction
end


Syntax Breakdown

Name Type Description
c "string" or nil This should be a "string" value containing the name of the character you want to affect, or nil if you want to link to the current character.
t "string" or nil This should be a "string" value containing the name of the character you want to align to, or nil if you want to link to the current character.