ScriptInstance.cpp 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879
  1. //
  2. // Copyright (c) 2008-2013 the Urho3D project.
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to deal
  6. // in the Software without restriction, including without limitation the rights
  7. // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  8. // copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19. // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  20. // THE SOFTWARE.
  21. //
  22. #include "Precompiled.h"
  23. #include "Context.h"
  24. #include "Log.h"
  25. #include "MemoryBuffer.h"
  26. #include "PhysicsEvents.h"
  27. #include "PhysicsWorld.h"
  28. #include "Profiler.h"
  29. #include "ResourceCache.h"
  30. #include "ResourceEvents.h"
  31. #include "Scene.h"
  32. #include "SceneEvents.h"
  33. #include "Script.h"
  34. #include "ScriptFile.h"
  35. #include "ScriptInstance.h"
  36. #include <angelscript.h>
  37. #include "DebugNew.h"
  38. namespace Urho3D
  39. {
  40. static const char* methodDeclarations[] = {
  41. "void Start()",
  42. "void Stop()",
  43. "void DelayedStart()",
  44. "void Update(float)",
  45. "void PostUpdate(float)",
  46. "void FixedUpdate(float)",
  47. "void FixedPostUpdate(float)",
  48. "void Load(Deserializer&)",
  49. "void Save(Serializer&)",
  50. "void ReadNetworkUpdate(Deserializer&)",
  51. "void WriteNetworkUpdate(Serializer&)",
  52. "void ApplyAttributes()",
  53. "void TransformChanged()"
  54. };
  55. extern const char* UI_CATEGORY;
  56. ScriptInstance::ScriptInstance(Context* context) :
  57. Component(context),
  58. script_(GetSubsystem<Script>()),
  59. scriptObject_(0),
  60. fixedUpdateFps_(0),
  61. fixedUpdateInterval_(0.0f),
  62. fixedUpdateAcc_(0.0f),
  63. fixedPostUpdateAcc_(0.0f),
  64. subscribed_(false),
  65. subscribedPostFixed_(false)
  66. {
  67. ClearScriptMethods();
  68. ClearScriptAttributes();
  69. }
  70. ScriptInstance::~ScriptInstance()
  71. {
  72. ReleaseObject();
  73. }
  74. void ScriptInstance::RegisterObject(Context* context)
  75. {
  76. context->RegisterFactory<ScriptInstance>(LOGIC_CATEGORY);
  77. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BOOL, "Is Enabled", IsEnabled, SetEnabled, bool, true, AM_DEFAULT);
  78. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_RESOURCEREF, "Script File", GetScriptFileAttr, SetScriptFileAttr, ResourceRef, ResourceRef(ScriptFile::GetTypeStatic()), AM_DEFAULT);
  79. REF_ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_STRING, "Class Name", GetClassName, SetClassName, String, String::EMPTY, AM_DEFAULT);
  80. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_INT, "Fixed Update FPS", GetFixedUpdateFps, SetFixedUpdateFps, int, 0, AM_DEFAULT);
  81. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_FLOAT, "Time Accumulator", GetFixedUpdateAccAttr, SetFixedUpdateAccAttr, float, 0.0f, AM_FILE | AM_NOEDIT);
  82. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Delayed Method Calls", GetDelayedMethodCallsAttr, SetDelayedMethodCallsAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  83. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Data", GetScriptDataAttr, SetScriptDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_FILE | AM_NOEDIT);
  84. ACCESSOR_ATTRIBUTE(ScriptInstance, VAR_BUFFER, "Script Network Data", GetScriptNetworkDataAttr, SetScriptNetworkDataAttr, PODVector<unsigned char>, Variant::emptyBuffer, AM_NET | AM_NOEDIT);
  85. }
  86. void ScriptInstance::OnSetAttribute(const AttributeInfo& attr, const Variant& src)
  87. {
  88. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  89. {
  90. // The component / node to which the ID refers to may not be in the scene yet, and furthermore the ID must go through the
  91. // SceneResolver first. Delay searching for the object to ApplyAttributes
  92. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  93. idAttributes_[attrPtr] = src.GetUInt();
  94. }
  95. else
  96. Serializable::OnSetAttribute(attr, src);
  97. }
  98. void ScriptInstance::OnGetAttribute(const AttributeInfo& attr, Variant& dest) const
  99. {
  100. AttributeInfo* attrPtr = const_cast<AttributeInfo*>(&attr);
  101. // Get ID's for node / component handle attributes
  102. if (attr.mode_ & (AM_NODEID | AM_COMPONENTID))
  103. {
  104. // If a cached ID value has been stored, return it instead of querying from the actual object
  105. // (the object handle is likely null at that point)
  106. HashMap<AttributeInfo*, unsigned>::ConstIterator i = idAttributes_.Find(attrPtr);
  107. if (i != idAttributes_.End())
  108. dest = i->second_;
  109. else if (attr.mode_ & AM_NODEID)
  110. {
  111. Node* node = *(reinterpret_cast<Node**>(attr.ptr_));
  112. unsigned nodeID = node ? node->GetID() : 0;
  113. dest = nodeID;
  114. }
  115. else
  116. {
  117. Component* component = *(reinterpret_cast<Component**>(attr.ptr_));
  118. unsigned componentID = component ? component->GetID() : 0;
  119. dest = componentID;
  120. }
  121. }
  122. else
  123. Serializable::OnGetAttribute(attr, dest);
  124. }
  125. void ScriptInstance::ApplyAttributes()
  126. {
  127. // Apply node / component ID attributes now (find objects from the scene and assign to the object handles)
  128. for (HashMap<AttributeInfo*, unsigned>::Iterator i = idAttributes_.Begin(); i != idAttributes_.End(); ++i)
  129. {
  130. AttributeInfo& attr = *i->first_;
  131. if (attr.mode_ & AM_NODEID)
  132. {
  133. Node*& nodePtr = *(reinterpret_cast<Node**>(attr.ptr_));
  134. // Decrease reference count of the old object if any, then increment the new
  135. if (nodePtr)
  136. nodePtr->ReleaseRef();
  137. nodePtr = GetScene()->GetNode(i->second_);
  138. if (nodePtr)
  139. nodePtr->AddRef();
  140. }
  141. else if (attr.mode_ & AM_COMPONENTID)
  142. {
  143. Component*& componentPtr = *(reinterpret_cast<Component**>(attr.ptr_));
  144. if (componentPtr)
  145. componentPtr->ReleaseRef();
  146. componentPtr = GetScene()->GetComponent(i->second_);
  147. if (componentPtr)
  148. componentPtr->AddRef();
  149. }
  150. }
  151. idAttributes_.Clear();
  152. if (scriptObject_ && methods_[METHOD_APPLYATTRIBUTES])
  153. scriptFile_->Execute(scriptObject_, methods_[METHOD_APPLYATTRIBUTES]);
  154. }
  155. void ScriptInstance::OnSetEnabled()
  156. {
  157. UpdateEventSubscription();
  158. }
  159. bool ScriptInstance::CreateObject(ScriptFile* scriptFile, const String& className)
  160. {
  161. className_ = String::EMPTY; // Do not create object during SetScriptFile()
  162. SetScriptFile(scriptFile);
  163. SetClassName(className);
  164. return scriptObject_ != 0;
  165. }
  166. void ScriptInstance::SetScriptFile(ScriptFile* scriptFile)
  167. {
  168. if (scriptFile == scriptFile_ && scriptObject_)
  169. return;
  170. ReleaseObject();
  171. // Unsubscribe from the reload event of previous script file (if any), then subscribe to the new
  172. if (scriptFile_)
  173. {
  174. UnsubscribeFromEvent(scriptFile_, E_RELOADSTARTED);
  175. UnsubscribeFromEvent(scriptFile_, E_RELOADFINISHED);
  176. }
  177. if (scriptFile)
  178. {
  179. SubscribeToEvent(scriptFile, E_RELOADSTARTED, HANDLER(ScriptInstance, HandleScriptFileReload));
  180. SubscribeToEvent(scriptFile, E_RELOADFINISHED, HANDLER(ScriptInstance, HandleScriptFileReloadFinished));
  181. }
  182. scriptFile_ = scriptFile;
  183. CreateObject();
  184. MarkNetworkUpdate();
  185. }
  186. void ScriptInstance::SetClassName(const String& className)
  187. {
  188. if (className == className_ && scriptObject_)
  189. return;
  190. ReleaseObject();
  191. className_ = className;
  192. CreateObject();
  193. MarkNetworkUpdate();
  194. }
  195. void ScriptInstance::SetFixedUpdateFps(int fps)
  196. {
  197. fixedUpdateFps_ = Max(fps, 0);
  198. fixedUpdateInterval_ = fixedUpdateFps_ ? (1.0f / fixedUpdateFps_) : 0.0f;
  199. fixedUpdateAcc_ = 0.0f;
  200. fixedPostUpdateAcc_ = 0.0f;
  201. MarkNetworkUpdate();
  202. }
  203. bool ScriptInstance::Execute(const String& declaration, const VariantVector& parameters)
  204. {
  205. if (!scriptObject_)
  206. return false;
  207. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  208. return scriptFile_->Execute(scriptObject_, method, parameters);
  209. }
  210. bool ScriptInstance::Execute(asIScriptFunction* method, const VariantVector& parameters)
  211. {
  212. if (!method || !scriptObject_)
  213. return false;
  214. return scriptFile_->Execute(scriptObject_, method, parameters);
  215. }
  216. void ScriptInstance::DelayedExecute(float delay, bool repeat, const String& declaration, const VariantVector& parameters)
  217. {
  218. if (!scriptObject_)
  219. return;
  220. DelayedMethodCall call;
  221. call.period_ = call.delay_ = Max(delay, 0.0f);
  222. call.repeat_ = repeat;
  223. call.declaration_ = declaration;
  224. call.parameters_ = parameters;
  225. delayedMethodCalls_.Push(call);
  226. // Make sure we are registered to the scene update event, because delayed calls are executed there
  227. if (!subscribed_)
  228. UpdateEventSubscription();
  229. }
  230. void ScriptInstance::ClearDelayedExecute(const String& declaration)
  231. {
  232. if (declaration.Empty())
  233. delayedMethodCalls_.Clear();
  234. else
  235. {
  236. for (Vector<DelayedMethodCall>::Iterator i = delayedMethodCalls_.Begin(); i != delayedMethodCalls_.End();)
  237. {
  238. if (declaration == i->declaration_)
  239. i = delayedMethodCalls_.Erase(i);
  240. else
  241. ++i;
  242. }
  243. }
  244. }
  245. void ScriptInstance::AddEventHandler(StringHash eventType, const String& handlerName)
  246. {
  247. if (!scriptObject_)
  248. return;
  249. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  250. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  251. if (!method)
  252. {
  253. declaration = "void " + handlerName + "()";
  254. method = scriptFile_->GetMethod(scriptObject_, declaration);
  255. if (!method)
  256. {
  257. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  258. return;
  259. }
  260. }
  261. SubscribeToEvent(eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  262. }
  263. void ScriptInstance::AddEventHandler(Object* sender, StringHash eventType, const String& handlerName)
  264. {
  265. if (!scriptObject_)
  266. return;
  267. if (!sender)
  268. {
  269. LOGERROR("Null event sender for event " + String(eventType) + ", handler " + handlerName);
  270. return;
  271. }
  272. String declaration = "void " + handlerName + "(StringHash, VariantMap&)";
  273. asIScriptFunction* method = scriptFile_->GetMethod(scriptObject_, declaration);
  274. if (!method)
  275. {
  276. declaration = "void " + handlerName + "()";
  277. method = scriptFile_->GetMethod(scriptObject_, declaration);
  278. if (!method)
  279. {
  280. LOGERROR("Event handler method " + handlerName + " not found in " + scriptFile_->GetName());
  281. return;
  282. }
  283. }
  284. SubscribeToEvent(sender, eventType, HANDLER_USERDATA(ScriptInstance, HandleScriptEvent, (void*)method));
  285. }
  286. void ScriptInstance::SetScriptFileAttr(ResourceRef value)
  287. {
  288. ResourceCache* cache = GetSubsystem<ResourceCache>();
  289. SetScriptFile(cache->GetResource<ScriptFile>(value.id_));
  290. }
  291. void ScriptInstance::SetDelayedMethodCallsAttr(PODVector<unsigned char> value)
  292. {
  293. MemoryBuffer buf(value);
  294. delayedMethodCalls_.Resize(buf.ReadVLE());
  295. for (Vector<DelayedMethodCall>::Iterator i = delayedMethodCalls_.Begin(); i != delayedMethodCalls_.End(); ++i)
  296. {
  297. i->period_ = buf.ReadFloat();
  298. i->delay_ = buf.ReadFloat();
  299. i->repeat_ = buf.ReadBool();
  300. i->declaration_ = buf.ReadString();
  301. i->parameters_ = buf.ReadVariantVector();
  302. }
  303. if (delayedMethodCalls_.Size() && !subscribed_)
  304. UpdateEventSubscription();
  305. }
  306. void ScriptInstance::SetFixedUpdateAccAttr(float value)
  307. {
  308. fixedUpdateAcc_ = value;
  309. fixedPostUpdateAcc_ = value;
  310. }
  311. void ScriptInstance::SetScriptDataAttr(PODVector<unsigned char> data)
  312. {
  313. if (scriptObject_ && methods_[METHOD_LOAD])
  314. {
  315. MemoryBuffer buf(data);
  316. VariantVector parameters;
  317. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  318. scriptFile_->Execute(scriptObject_, methods_[METHOD_LOAD], parameters);
  319. }
  320. }
  321. void ScriptInstance::SetScriptNetworkDataAttr(PODVector<unsigned char> data)
  322. {
  323. if (scriptObject_ && methods_[METHOD_READNETWORKUPDATE])
  324. {
  325. MemoryBuffer buf(data);
  326. VariantVector parameters;
  327. parameters.Push(Variant((void*)static_cast<Deserializer*>(&buf)));
  328. scriptFile_->Execute(scriptObject_, methods_[METHOD_READNETWORKUPDATE], parameters);
  329. }
  330. }
  331. ResourceRef ScriptInstance::GetScriptFileAttr() const
  332. {
  333. return GetResourceRef(scriptFile_, ScriptFile::GetTypeStatic());
  334. }
  335. PODVector<unsigned char> ScriptInstance::GetDelayedMethodCallsAttr() const
  336. {
  337. VectorBuffer buf;
  338. buf.WriteVLE(delayedMethodCalls_.Size());
  339. for (Vector<DelayedMethodCall>::ConstIterator i = delayedMethodCalls_.Begin(); i != delayedMethodCalls_.End(); ++i)
  340. {
  341. buf.WriteFloat(i->period_);
  342. buf.WriteFloat(i->delay_);
  343. buf.WriteBool(i->repeat_);
  344. buf.WriteString(i->declaration_);
  345. buf.WriteVariantVector(i->parameters_);
  346. }
  347. return buf.GetBuffer();
  348. }
  349. float ScriptInstance::GetFixedUpdateAccAttr() const
  350. {
  351. return fixedUpdateAcc_;
  352. }
  353. PODVector<unsigned char> ScriptInstance::GetScriptDataAttr() const
  354. {
  355. if (!scriptObject_ || !methods_[METHOD_SAVE])
  356. return PODVector<unsigned char>();
  357. else
  358. {
  359. VectorBuffer buf;
  360. VariantVector parameters;
  361. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  362. scriptFile_->Execute(scriptObject_, methods_[METHOD_SAVE], parameters);
  363. return buf.GetBuffer();
  364. }
  365. }
  366. PODVector<unsigned char> ScriptInstance::GetScriptNetworkDataAttr() const
  367. {
  368. if (!scriptObject_ || !methods_[METHOD_WRITENETWORKUPDATE])
  369. return PODVector<unsigned char>();
  370. else
  371. {
  372. VectorBuffer buf;
  373. VariantVector parameters;
  374. parameters.Push(Variant((void*)static_cast<Serializer*>(&buf)));
  375. scriptFile_->Execute(scriptObject_, methods_[METHOD_WRITENETWORKUPDATE], parameters);
  376. return buf.GetBuffer();
  377. }
  378. }
  379. void ScriptInstance::OnMarkedDirty(Node* node)
  380. {
  381. // Script functions are not safe from worker threads
  382. Scene* scene = GetScene();
  383. if (scene && scene->IsThreadedUpdate())
  384. {
  385. scene->DelayedMarkedDirty(this);
  386. return;
  387. }
  388. if (scriptObject_ && methods_[METHOD_TRANSFORMCHANGED])
  389. scriptFile_->Execute(scriptObject_, methods_[METHOD_TRANSFORMCHANGED]);
  390. }
  391. void ScriptInstance::CreateObject()
  392. {
  393. if (!scriptFile_ || className_.Empty())
  394. return;
  395. PROFILE(CreateScriptObject);
  396. scriptObject_ = scriptFile_->CreateObject(className_);
  397. if (scriptObject_)
  398. {
  399. // Map script object to script instance with userdata
  400. scriptObject_->SetUserData(this);
  401. ClearDelayedExecute();
  402. GetScriptMethods();
  403. GetScriptAttributes();
  404. UpdateEventSubscription();
  405. if (methods_[METHOD_START])
  406. scriptFile_->Execute(scriptObject_, methods_[METHOD_START]);
  407. }
  408. else
  409. LOGERROR("Failed to create object of class " + className_ + " from " + scriptFile_->GetName());
  410. }
  411. void ScriptInstance::ReleaseObject()
  412. {
  413. if (scriptObject_)
  414. {
  415. if (methods_[METHOD_STOP])
  416. scriptFile_->Execute(scriptObject_, methods_[METHOD_STOP]);
  417. PODVector<StringHash> exceptions;
  418. exceptions.Push(E_RELOADSTARTED);
  419. exceptions.Push(E_RELOADFINISHED);
  420. UnsubscribeFromAllEventsExcept(exceptions, false);
  421. if (node_)
  422. node_->RemoveListener(this);
  423. subscribed_ = false;
  424. subscribedPostFixed_ = false;
  425. ClearScriptMethods();
  426. ClearScriptAttributes();
  427. scriptObject_->SetUserData(0);
  428. scriptObject_->Release();
  429. scriptObject_ = 0;
  430. }
  431. }
  432. void ScriptInstance::ClearScriptMethods()
  433. {
  434. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  435. methods_[i] = 0;
  436. delayedMethodCalls_.Clear();
  437. }
  438. void ScriptInstance::ClearScriptAttributes()
  439. {
  440. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  441. idAttributes_.Clear();
  442. }
  443. void ScriptInstance::GetScriptMethods()
  444. {
  445. for (unsigned i = 0; i < MAX_SCRIPT_METHODS; ++i)
  446. methods_[i] = scriptFile_->GetMethod(scriptObject_, methodDeclarations[i]);
  447. }
  448. void ScriptInstance::GetScriptAttributes()
  449. {
  450. asIScriptEngine* engine = GetSubsystem<Script>()->GetScriptEngine();
  451. attributeInfos_ = *context_->GetAttributes(GetTypeStatic());
  452. unsigned numProperties = scriptObject_->GetPropertyCount();
  453. for (unsigned i = 0; i < numProperties; ++i)
  454. {
  455. const char* name;
  456. int typeId;
  457. bool isPrivate, isHandle;
  458. scriptObject_->GetObjectType()->GetProperty(i, &name, &typeId, &isPrivate);
  459. // Hide private variables or ones that begin with an underscore
  460. if (isPrivate || name[0] == '_')
  461. continue;
  462. String typeName = engine->GetTypeDeclaration(typeId);
  463. isHandle = typeName.EndsWith("@");
  464. if (isHandle)
  465. typeName = typeName.Substring(0, typeName.Length() - 1);
  466. AttributeInfo info;
  467. info.mode_ = AM_FILE;
  468. info.name_ = name;
  469. info.ptr_ = scriptObject_->GetAddressOfProperty(i);
  470. if (!isHandle)
  471. {
  472. switch (typeId)
  473. {
  474. case asTYPEID_BOOL:
  475. info.type_ = VAR_BOOL;
  476. break;
  477. case asTYPEID_INT32:
  478. case asTYPEID_UINT32:
  479. info.type_ = VAR_INT;
  480. break;
  481. case asTYPEID_FLOAT:
  482. info.type_ = VAR_FLOAT;
  483. break;
  484. default:
  485. info.type_ = Variant::GetTypeFromName(typeName);
  486. break;
  487. }
  488. }
  489. else
  490. {
  491. // For a handle type, check if it's an Object subclass with a registered factory
  492. ShortStringHash typeHash(typeName);
  493. const HashMap<ShortStringHash, SharedPtr<ObjectFactory> >& factories = context_->GetObjectFactories();
  494. const HashMap<String, Vector<ShortStringHash> >& categories = context_->GetObjectCategories();
  495. if (factories.Find(typeHash) != factories.End())
  496. {
  497. // There are four possibilities: the handle is for a Node, a Component or UIElement subclass, or for some
  498. // other refcounted object. We can handle nodes & components with ID attributes, but want to skip the others
  499. HashMap<String, Vector<ShortStringHash> >::ConstIterator ui = categories.Find(UI_CATEGORY);
  500. if (ui != categories.End() && ui->second_.Contains(typeHash))
  501. continue; // Is handle to a UIElement; can not handle those
  502. else if (typeHash == Node::GetTypeStatic() || typeHash == Scene::GetTypeStatic())
  503. {
  504. info.mode_ |= AM_NODEID;
  505. info.type_ = VAR_INT;
  506. }
  507. else
  508. {
  509. // If is found in one of the component categories, must be a component
  510. // Note: this requires that custom components are registered inside component categories as well
  511. for (HashMap<String, Vector<ShortStringHash> >::ConstIterator i = categories.Begin(); i != categories.End();
  512. ++i)
  513. {
  514. if (i->second_.Contains(typeHash))
  515. {
  516. info.mode_ |= AM_COMPONENTID;
  517. info.type_ = VAR_INT;
  518. break;
  519. }
  520. }
  521. }
  522. }
  523. }
  524. if (info.type_ != VAR_NONE)
  525. attributeInfos_.Push(info);
  526. }
  527. }
  528. void ScriptInstance::UpdateEventSubscription()
  529. {
  530. Scene* scene = GetScene();
  531. if (!scene)
  532. {
  533. LOGWARNING("Node is detached from scene, can not subscribe script object to update events");
  534. return;
  535. }
  536. bool enabled = scriptObject_ && IsEnabledEffective();
  537. if (enabled)
  538. {
  539. if (!subscribed_ && (methods_[METHOD_UPDATE] || methods_[METHOD_DELAYEDSTART] || delayedMethodCalls_.Size()))
  540. {
  541. SubscribeToEvent(scene, E_SCENEUPDATE, HANDLER(ScriptInstance, HandleSceneUpdate));
  542. subscribed_ = true;
  543. }
  544. if (!subscribedPostFixed_)
  545. {
  546. if (methods_[METHOD_POSTUPDATE])
  547. SubscribeToEvent(scene, E_SCENEPOSTUPDATE, HANDLER(ScriptInstance, HandleScenePostUpdate));
  548. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  549. if (world)
  550. {
  551. if (methods_[METHOD_FIXEDUPDATE])
  552. SubscribeToEvent(world, E_PHYSICSPRESTEP, HANDLER(ScriptInstance, HandlePhysicsPreStep));
  553. if (methods_[METHOD_FIXEDPOSTUPDATE])
  554. SubscribeToEvent(world, E_PHYSICSPOSTSTEP, HANDLER(ScriptInstance, HandlePhysicsPostStep));
  555. }
  556. else
  557. {
  558. if (methods_[METHOD_FIXEDUPDATE] || methods_[METHOD_FIXEDPOSTUPDATE])
  559. LOGERROR("No physics world, can not subscribe script object to fixed update events");
  560. }
  561. subscribedPostFixed_ = true;
  562. }
  563. if (methods_[METHOD_TRANSFORMCHANGED])
  564. node_->AddListener(this);
  565. }
  566. else
  567. {
  568. if (subscribed_)
  569. {
  570. UnsubscribeFromEvent(scene, E_SCENEUPDATE);
  571. subscribed_ = false;
  572. }
  573. if (subscribedPostFixed_)
  574. {
  575. UnsubscribeFromEvent(scene, E_SCENEPOSTUPDATE);
  576. PhysicsWorld* world = scene->GetComponent<PhysicsWorld>();
  577. if (world)
  578. {
  579. UnsubscribeFromEvent(world, E_PHYSICSPRESTEP);
  580. UnsubscribeFromEvent(world, E_PHYSICSPOSTSTEP);
  581. }
  582. subscribedPostFixed_ = false;
  583. }
  584. if (methods_[METHOD_TRANSFORMCHANGED])
  585. node_->RemoveListener(this);
  586. }
  587. }
  588. void ScriptInstance::HandleSceneUpdate(StringHash eventType, VariantMap& eventData)
  589. {
  590. if (!scriptObject_)
  591. return;
  592. using namespace SceneUpdate;
  593. float timeStep = eventData[P_TIMESTEP].GetFloat();
  594. // Execute delayed method calls
  595. for (unsigned i = 0; i < delayedMethodCalls_.Size();)
  596. {
  597. DelayedMethodCall& call = delayedMethodCalls_[i];
  598. bool remove = false;
  599. call.delay_ -= timeStep;
  600. if (call.delay_ <= 0.0f)
  601. {
  602. if (!call.repeat_)
  603. remove = true;
  604. else
  605. call.delay_ += call.period_;
  606. Execute(call.declaration_, call.parameters_);
  607. }
  608. if (remove)
  609. delayedMethodCalls_.Erase(i);
  610. else
  611. ++i;
  612. }
  613. // Execute delayed start before first update
  614. if (methods_[METHOD_DELAYEDSTART])
  615. {
  616. scriptFile_->Execute(scriptObject_, methods_[METHOD_DELAYEDSTART]);
  617. methods_[METHOD_DELAYEDSTART] = 0; // Only execute once
  618. }
  619. if (methods_[METHOD_UPDATE])
  620. {
  621. VariantVector parameters;
  622. parameters.Push(timeStep);
  623. scriptFile_->Execute(scriptObject_, methods_[METHOD_UPDATE], parameters);
  624. }
  625. }
  626. void ScriptInstance::HandleScenePostUpdate(StringHash eventType, VariantMap& eventData)
  627. {
  628. if (!scriptObject_)
  629. return;
  630. using namespace ScenePostUpdate;
  631. VariantVector parameters;
  632. parameters.Push(eventData[P_TIMESTEP]);
  633. scriptFile_->Execute(scriptObject_, methods_[METHOD_POSTUPDATE], parameters);
  634. }
  635. void ScriptInstance::HandlePhysicsPreStep(StringHash eventType, VariantMap& eventData)
  636. {
  637. if (!scriptObject_)
  638. return;
  639. using namespace PhysicsPreStep;
  640. if (!fixedUpdateFps_)
  641. {
  642. VariantVector parameters;
  643. parameters.Push(eventData[P_TIMESTEP]);
  644. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  645. }
  646. else
  647. {
  648. float timeStep = eventData[P_TIMESTEP].GetFloat();
  649. fixedUpdateAcc_ += timeStep;
  650. if (fixedUpdateAcc_ >= fixedUpdateInterval_)
  651. {
  652. fixedUpdateAcc_ = fmodf(fixedUpdateAcc_, fixedUpdateInterval_);
  653. VariantVector parameters;
  654. parameters.Push(fixedUpdateInterval_);
  655. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDUPDATE], parameters);
  656. }
  657. }
  658. }
  659. void ScriptInstance::HandlePhysicsPostStep(StringHash eventType, VariantMap& eventData)
  660. {
  661. if (!scriptObject_)
  662. return;
  663. using namespace PhysicsPostStep;
  664. if (!fixedUpdateFps_)
  665. {
  666. VariantVector parameters;
  667. parameters.Push(eventData[P_TIMESTEP]);
  668. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  669. }
  670. else
  671. {
  672. float timeStep = eventData[P_TIMESTEP].GetFloat();
  673. fixedPostUpdateAcc_ += timeStep;
  674. if (fixedPostUpdateAcc_ >= fixedUpdateInterval_)
  675. {
  676. fixedPostUpdateAcc_ = fmodf(fixedPostUpdateAcc_, fixedUpdateInterval_);
  677. VariantVector parameters;
  678. parameters.Push(fixedUpdateInterval_);
  679. scriptFile_->Execute(scriptObject_, methods_[METHOD_FIXEDPOSTUPDATE], parameters);
  680. }
  681. }
  682. }
  683. void ScriptInstance::HandleScriptEvent(StringHash eventType, VariantMap& eventData)
  684. {
  685. if (!IsEnabledEffective() || !scriptFile_ || !scriptObject_)
  686. return;
  687. asIScriptFunction* method = static_cast<asIScriptFunction*>(GetEventHandler()->GetUserData());
  688. VariantVector parameters;
  689. if (method->GetParamCount() > 0)
  690. {
  691. parameters.Push(Variant((void*)&eventType));
  692. parameters.Push(Variant((void*)&eventData));
  693. }
  694. scriptFile_->Execute(scriptObject_, method, parameters);
  695. }
  696. void ScriptInstance::HandleScriptFileReload(StringHash eventType, VariantMap& eventData)
  697. {
  698. ReleaseObject();
  699. }
  700. void ScriptInstance::HandleScriptFileReloadFinished(StringHash eventType, VariantMap& eventData)
  701. {
  702. if (!className_.Empty())
  703. CreateObject();
  704. }
  705. Context* GetScriptContext()
  706. {
  707. return static_cast<Script*>(asGetActiveContext()->GetEngine()->GetUserData())->GetContext();
  708. }
  709. ScriptInstance* GetScriptContextInstance()
  710. {
  711. asIScriptContext* context = asGetActiveContext();
  712. asIScriptObject* object = context ? static_cast<asIScriptObject*>(context->GetThisPointer()) : 0;
  713. if (object)
  714. return static_cast<ScriptInstance*>(object->GetUserData());
  715. else
  716. return 0;
  717. }
  718. Node* GetScriptContextNode()
  719. {
  720. ScriptInstance* instance = GetScriptContextInstance();
  721. return instance ? instance->GetNode() : 0;
  722. }
  723. Scene* GetScriptContextScene()
  724. {
  725. Scene* scene = 0;
  726. Node* node = GetScriptContextNode();
  727. if (node)
  728. scene = node->GetScene();
  729. // If null, try to get the default scene
  730. if (!scene)
  731. scene = GetScriptContext()->GetSubsystem<Script>()->GetDefaultScene();
  732. return scene;
  733. }
  734. ScriptEventListener* GetScriptContextEventListener()
  735. {
  736. // If context's this pointer is non-null, try to get the script instance. Else get the script file for procedural
  737. // event handling
  738. asIScriptContext* context = asGetActiveContext();
  739. if (context)
  740. {
  741. if (context->GetThisPointer())
  742. return GetScriptContextInstance();
  743. else
  744. return GetScriptContextFile();
  745. }
  746. else
  747. return 0;
  748. }
  749. Object* GetScriptContextEventListenerObject()
  750. {
  751. return dynamic_cast<Object*>(GetScriptContextEventListener());
  752. }
  753. }