ScriptInstance.cpp 28 KB

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